Model Class

Statical model that contains all relevant model information.

Definition

Namespace: Karamba.Models
Assembly: KarambaCommon (in KarambaCommon.dll) Version: 3.0.8.0+eb23a7103f0eca0b6d808121e15fec6899194e15

[SerializableAttribute]
public class Model : CommonObject, ICloneable, 
	ISerializable, IEquatable<Model>

<SerializableAttribute>
Public Class Model
	Inherits CommonObject
	Implements ICloneable, ISerializable, IEquatable(Of Model)

C++

[SerializableAttribute]
public ref class Model : public CommonObject, 
	ICloneable, ISerializable, IEquatable<Model^>

[<SerializableAttribute>]
type Model = 
    class
        inherit CommonObject
        interface ICloneable
        interface ISerializable
        interface IEquatable<Model>
    end

Inheritance: Object CommonObject Model

Implements: ICloneable, IEquatableModel, ISerializable

Constructors

Model	Initializes a new instance of the Model class. create a new, empty model.
Model(SerializationInfo, StreamingContext)	Initializes a new instance of the Model class. de-serialization constructor.
Model(ListNode, ListFemMaterial, ListCroSec, ListModelElement, LoadCaseCombinationCollection, ListLoad, ListBuilderLoadCaseCombination, ListBuilderLoadCaseOptions, ListPointLoad, ListPointMass, ListMeshLoad, ListElementLoad, ListSupport, ListElemSet, DictionaryString, GravityLoad, IdMapper, DictionaryGuid, ListInt32, DictionaryInt32, ListInt32, NKDTreeDupli, IdIndexer)	Initializes a new instance of the Model class. create a model based on some input.

Properties

BeamCount	Gets BeamCount which is needed to handle licenses.
BoundingBox	Gets the bounding box of the model.
element_selector	Gets selector for getting elements based in their identifier.
ElemGuid2Ind	Gets mapping from BuilderBeam Guids to indexes of ModelElements.
elemId2elemInd	Gets or sets mapper that converts element ids (identifiers, i.e. strings) to element indexes.
febmodel	Gets or sets c++-model connected to the C#-model.
febmodelWasMapped	Gets or sets a value indicating whether the C#-model needs to be updated in case of true.
IsValid	Gets a value indicating whether the model is valid.
Meshes	Gets collection of shell meshes.
result_type	Gets or sets type of model-case currently attached to the model.
ShellCount	Gets ShellCount which is needed to handle licenses.
UserData	Gets access to the user-data dictionary. (Inherited from CommonObject)

Methods

add	Adds a vertex to the model and returns its index.
addRange	Add a load to the list of input model-loads.
buildFEModel	Build finite element model from given geometry with a minimum of _lc_number load cases.
characteristicLength	calculates approximate maximum distance of two points in the model.
check_results_availability	check whether there are results available for the model and throw an exception in case there are none.
clearLoads	Clear all loads.
Clone	shallow clone the model and Lcear the preview.
cloneElements	clone the model's elements. Must be done before changing them in order to avoid side-effects.
cloneInLoads	Shallow clone the model's load case combination collection.
cloneLoadCaseCombinationCollection	clone the model's load case combination collection.
cloneLoadCaseCombinationOptions	clone the model's load case combination collection.
cloneMaterialList	clone the model's materials. Must be done before changing them in order to avoid side-effects.
cloneNodes	clone the model's nodes. Must be done before changing them in order to avoid side-effects.
clonePointLoads	clone the model's point-loads. Must be done before changing them in order to avoid side-effects.
cloneSupportPosition	clone the model's supports. Must be done before changing them in order to avoid side-effects.
cloneVertexPosition	clone the model's vertex positions. Must be done before changing them in order to avoid side-effects.
createFemBeam(String)	Create a ModelBeam and corresponding BuilderBeam by cloning another beam of given identification string: add CrossSection and element load information.
createFemBeam(Int32, ListInt32)	Creates a BuilderBeam and ModelBeam from beam index number: add CrossSection, Material and element load information.
crosec_ind	maps cross section guids to crosec indexes.
deepCloneFEModel	deep clone the C++-model.
Disassemble	disassemble the model and output its parts.
displacementsReady	true if model displacements have been calculated.
ElementInds(Guid)	Retrieves element indexes connected to a given guid.
ElementInds(IReadOnlyListGuid)	Retrieves element indexes connected to a given guid.
ElementInds(IReadOnlyListString)	Retrieves element indexes connected to a given element identifier.
Elements	return all elements of the model.
Elements(Guid)	Retrieves elements connected to a given guid.
Elements(IEnumerableInt32)	Retrieves elements connected to a given indexes.
Elements(IEnumerableString)	return set of element which match one of the given identifiers.
elementsByID	returns list of elements that correspond to the given ids.
ElemGuid2ElemInd	Return element indexes for lists of guids.
Equals(Model)	True if item is equal to this.
Equals(Object)	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object))
fe2model	update the model with data from the fe-model. Both models may be out of sync after mappings were performed on the fe-model. Has to be called before displaying the model or retrieving results.
fe2model_update_NII	update the NII forces based on the fe-model.
femodelWasMapped	gets called when a mapping was applied to the fe-model and the model needs an update before display.
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
fitForCalculation	Return true if the model can be calculated.
fitForCalculationMsg	Return message why model can not be calculated.
forcesReady	true if forces in the model have been calculated.
GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode)
GetObjectData	Serializes the model-object. (Overrides CommonObjectGetObjectData(SerializationInfo, StreamingContext))
GetType	Gets the Type of the current instance. (Inherited from Object)
HasUserData	Checks whether the object has user-data attached. (Inherited from CommonObject)
id_num	Returns the element's identification number for an identifier.
initElementGuid2Ind	initialize the mapping from element Guids to element indexes.
initMaterialCroSecLists	initialize the list of materials and cross sections.
initShellMeshes	initialize the model's shell meshes.
mass	mass of the model.
massAndCOG	calculate the mass in kg and center of gravity of the model.
material_ind	maps material guids to material indexes.
maxAbsLoad	Calculates maximum absolute value of a point-load or mesh-load in the model which is used for scaling the load symbols.
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
minmaxEpsX	calculate min/max axial strain in model.
NodeInd	Gets the index of the node at the given position within the search radius limitDist. If no point is within reach -1 is returned.
NodeIndToElementInds	Gets the list of element indices adjacent to a node of given index.
setCroSecGroupIds	sets the cross section family indexes according to the values in the given dictionary.
setCroSecMaterial	Sets the cross sections material. The cross-section references the material. Add the material to the model if not already there and set the name.
setNumberOfLoadcases	this is used to limit the number of load-cases in case of eigenform- or natural frequency calculations.
Support	Get support at node of specified index.
syncNumberOfLoadcases	synchronize the number of load-cases with the feb-model.
ToString	string representation of the model. (Overrides CommonObjectToString)
Transform	transform the model.
updateDeformation	Updates the deformed node positions of the model and returns a model with new initial node positions.
updateMaterialCroSecLists	update the list of materials and cross-sections.

Fields

beamsets	beamsets of the model.
crosecs	cross sections of the model.
Crossection2Ind	maps cross section guids to crosec indexes.
dp	display properties.
elemGuid2Ind	maps BuilderBeam Guids to indexes of ModelElements.
elems	elements of the model.
eloads	element loads of the model.
gravities	gravity definitions of the model. Maps LoadCaseCombinationNames to gravities.
Guid	the material's identifier.
joints	joints of the model.
lcActivation	manages the activation of load-cases for analysis.
lcCombinationCollection	collects the load-cases and load-case combinations.
lcCombinationOptions	rules for combining loads.
lcCombinations	rules for combining loads.
material2ind_	maps materials to material indexes.
materials	materials of the model.
maxDisp	maximum displacement of all load-cases.
maxEpsX	minimum strain in the structure - only valid if minmaxEpsX_isValid == true.
minEpsX	minimum strain in the structure - only valid if minmaxEpsX_isValid == true.
minmaxEpsX_isValid	true if min/max EpsX has been calculated.
mloads	mesh-loads of the model.
nodes	system nodes in their original position.
NumberOfCreatedFiniteElements	number of elements which were computer generated in the course of e.g. splitting beams.
ploads	point loads that act on the model.
pmass	point masses of the model.
supports	supports of the model.

Extension Methods

ContainerType

test if object is (a container like) a list or an array.
(Defined by MiniUtil)