Click or drag to resize

Model Class

Statical model that contains all relevant model information.
Inheritance Hierarchy

Namespace:  Karamba.Models
Assembly:  KarambaCommon (in KarambaCommon.dll) Version: 2.2.0.4 (2.2.0.4)
Syntax
[SerializableAttribute]
public class Model : CommonObject, ICloneable, 
	ISerializable

The Model type exposes the following members.

Constructors
  NameDescription
Public methodModel
Initializes a new instance of the Model class. create a new, empty model.
Protected methodModel(SerializationInfo, StreamingContext)
Initializes a new instance of the Model class. de-serialization constructor.
Public methodModel(ListNode, ListFemMaterial, ListCroSec, ListModelElement, LCCombiCollector, ListLoadCaseCombination, 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.
Top
Properties
  NameDescription
Public propertyBoundingBox
Gets the bounding box of the model.
Public propertyelement_selector
Gets selector for getting elements based in their identifier.
Public propertyelemId2elemInd
Gets or sets mapper that converts element ids (identifiers, i.e. strings) to element indexes.
Public propertyfebmodel
Gets or sets c++-model connected to the C#-model.
Public propertyfebmodelWasMapped
Gets or sets a value indicating whether the C#-model needs to be updated in case of true.
Public propertyIsValid
Gets a value indicating whether the model is valid.
Public propertylc_super_model_displacements
Gets superPosition factors for displacements.
Public propertylc_super_model_results
Gets superPosition rule for rendering model results.
Public propertyMeshes
Gets collection of shell meshes.
Public propertynumLC
Gets number of calculated load-cases in the model.
Public propertyresult_type
Gets or sets type of model-case currently attached to the model.
Public propertyUserData
Gets access to the user-data dictionary.
(Inherited from CommonObject.)
Top
Methods
  NameDescription
Public methodadd
Adds a vertex to the model and returns its index.
Public methodbuildFEModel
Build finite element model from given geometry with a minimum of _lc_number load cases.
Public methodcharacteristicLength
calculates approximate maximum distance of two points in the model.
Public methodcheck_loadcase_index
check whether there are results available for the model and a specific load-case and throw an exception in case there are none.
Public methodcheck_results_availability
check whether there are results available for the model and throw an exception in case there are none.
Public methodclearLoads
Clear all loads.
Public methodClone
shallow clone the model.
Public methodcloneElements
clone the model's elements. Must be done before changing them in order to avoid side-effects.
Public methodcloneMaterialList
clone the model's materials. Must be done before changing them in order to avoid side-effects.
Public methodcloneNodes
clone the model's nodes. Must be done before changing them in order to avoid side-effects.
Public methodclonePointLoads
clone the model's point-loads. Must be done before changing them in order to avoid side-effects.
Public methodcloneSupportPosition
clone the model's supports. Must be done before changing them in order to avoid side-effects.
Public methodcloneVertexPosition
clone the model's vertex positions. Must be done before changing them in order to avoid side-effects.
Public methodcreateFemBeam(String)
Create a ModelBeam and corresponding BuilderBeam by cloning another beam of given identification string: add CrossSection and element load information.
Public methodcreateFemBeam(Int32, ListInt32)
Creates a BuilderBeam and ModelBeam from beam index number: add CrossSection, Material and element load information.
Public methodcrosec_ind
maps cross section guids to crosec indexes.
Public methoddeepCloneFEModel
deep clone the C++-model.
Public methodDisassemble
disassemble the model and ouput its parts.
Public methoddisplacementsReady
true if model displacements have been calculated.
Public methodElementInds(ListGuid)
Retrieves element indexes connected to a given guid.
Public methodElementInds(ListString)
Retrieves element indexes connected to a given element identifier.
Public methodElementInds(Guid)
Retrieves element indexes connected to a given guid.
Public methodElements
return all elements of the model.
Public methodElements(IEnumerableInt32)
Retrieves elements connected to a given indexes.
Public methodElements(ListString)
return set of element which match one of the given identifiers.
Public methodElements(Guid)
Retrieves elements connected to a given guid.
Public methodelementsByID
returns list of elements that correspond to the given ids.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodfe2model
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.
Public methodfe2model_update_NII
update the NII forces based on the fe-model.
Public methodfemodelWasMapped
gets called when a mapping was applied to the fe-model and the model needs an update before display.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodfitForCalculation
Return true if the model can be calculated.
Public methodfitForCalculationMsg
Return message why model can not be calculated.
Public methodforcesReady
true if forces in the model have been calculated.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetObjectData
Serializes the model-object.
(Overrides CommonObjectGetObjectData(SerializationInfo, StreamingContext).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasUserData
true if the object has user-data attached.
(Inherited from CommonObject.)
Public methodid_num
Returns the element's identification number for anidentifier.
Protected methodinitElementGuid2Ind
initialize the mapping from element Guids to element indexes.
Public methodinitMaterialCroSecLists
initialize the list of materials and cross sections.
Public methodinitShellMeshes
initialize the model's shell meshes.
Public methodmass
mass of the model.
Public methodmassAndCOG
calculate the mass in kg and center of gravity of the model.
Public methodmaterial_ind
maps material guids to material indexes.
Public methodmaxAbsLoad
Calculates maximum absolute value of a point-load or mesh-load in the model which is used for scaling the load symbols.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodminmaxEpsX
calculate min/max axial strain in model.
Public methodNodeInd
Gets the index of the node at the given position within the search radius limitDist. If no point is within reach -1 is returned.
Public methodNodeIndToElementInds
Gets the list of element indices adjacent to a node of given index.
Public methodsetCroSecGroupIds
sets the cross section family indexes according to the values in the given dictionary.
Public methodsetCroSecMaterial
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.
Public methodsetLoadCaseFactors
set the load case factors and the SuperPosition factors for calculating states and display displacements.
Public methodsetNumberOfLoadcases
this is used to limit the number of load-cases in case of eigenform- or natural frequency calculations.
Public methodSupport
Get support at node of specified index.
Public methodsyncNumberOfLoadcases
synchronize the number of load-cases with the feb-model.
Public methodToString
string representation of the model.
(Overrides CommonObjectToString.)
Public methodTransform
transform the model.
Public methodupdateDeformation
Set position of displaced vertices in this model. Deform geometry of def_model by adding displacements of given load-case multiplied by factor. Use projection currently in use for the model.
Public methodupdateMaterialCroSecLists
update the list of materials and cross sections.
Top
Fields
  NameDescription
Protected field_elem_guid2ind
maps BuilderBeam Guids to indexes of ModelElements.
Public fieldbeamsets
beamsets of the model.
Protected fieldcro_guid2ind_
maps cross section guids to crosec indexes.
Public fieldcrosecs
cross sections of the model.
Public fielddp
display properties.
Public fieldelems
elements of the model.
Public fieldeloads
element loads of the model.
Public fieldgravities
gravity definitions of the model.
Public fieldin_crosecs
list of cross sections which were input by the user when assembling the model.
Public fieldin_materials
list of materials which were input by the user when assembling the model.
Public fieldjoints
joints of the model.
Public fieldlc_combinator
maps load-case names to load-case indexes.
Protected fieldlc_super_model_results_
SuperPosition rule for rendering model results.
Public fieldlcCombinations
rules for combining loads.
Protected fieldmat_guid2ind_
maps material guids to material indexes.
Public fieldmaterials
materials of the model.
Public fieldmaxDisp
maximum displacement of all load-cases.
Public fieldmaxEpsX
minimum strain in the structure - only valid if minmaxEpsX_isValid == true.
Public fieldminEpsX
minimum strain in the structure - only valid if minmaxEpsX_isValid == true.
Public fieldminmaxEpsX_isValid
true if min/max EpsX has been calculated.
Public fieldmloads
mesh-loads of the model.
Public fieldnodes
system nodes in their original position.
Public fieldnumber_of_created_finite_elements
number of elements which were computer generated in the course of e.g. splitting beams.
Public fieldploads
point loads that act on the model.
Public fieldpmass
point masses of the model.
Public fieldsupports
supports of the model.
Top
See Also