model.common()
The common list contains nodes that have different purposes depending on the node type. The type is assigned when the node is created. All other properties are set and accessed using generic set and get methods as described under set() and get* and Selection Access Methods. The different types may or may not use a selection. The following node types are currently defined:
Syntax
model.component(<ctag>).common().create(<tag>,type);
model.component(<ctag>).common(<tag>).set(property, <value>);
model.component(<ctag>).common(<tag>).image()
Description
model.component(<ctag>).common().create(<tag>,type) creates a common feature node with the given tag and type.
model.component(<ctag>).common(<tag>).set(property, <value>) sets a named property in the common feature with tag <tag> in component <ctag>.
ExpressionOperator
model.component(<ctag>).common().create(<tag>,"ExpressionOperator") creates an expression operator feature. The following properties are available.
Pass the arguments by reference (when set to "off") or by value (when set to "on").
OperatorContribution
model.component(<ctag>).common(<exop>).create(<tag>,"OperatorContribution") creates an Operator Contribution feature as a subfeature to the Expression Operator feature with tag <exop>. The following properties are available.
Matrix
model.component(<ctag>).common().create(<tag>,"Matrix") creates a matrix variable feature. For a Matrix definition, the following properties are available.
full | symmetric | hermitian
Matrix size when userDefined. Sizes up to 50-by50 are allowed.
MatrixInverse
model.component(<ctag>).common().create(<tag>,"MatrixInverse") creates a matrix inverse feature. For a MatrixInverse definition, the following properties are available.
full | symmetric | hermitian
Matrix size when userDefined. Sizes up to 50-by50 are allowed.
MatrixDiagonalization
model.component(<ctag>).common().create(<tag>,"MatrixDiagonalization") creates a matrix diagonalization feature. For a MatrixDiagonalization definition, the following properties are available.
true | false
true | false
MatrixDecomposition
model.component(<ctag>).common().create(<tag>,"MatrixDecomposition") creates a matrix decomposition (SVD) feature. For a MatrixDecomposition definition, the following properties are available.
true | false
true | false
true | false
true | false
full | symmetric | hermitian
Matrix size when userDefined. Sizes up to 50-by50 are allowed.
VectorTransform
model.component(<ctag>).common().create(<tag>,"VectorTransform", <component>) creates a vector transformation feature that transforms vectors from one coordinate system to another. For a VectorTransform definition, the following properties are available.
none | raiseIndex | lowerIndex
contravariant | covariant
mesh | geometry | material | spatial
global:spatial | global:material | <coordsys_tag>
global:spatial | global:material | <coordsys_tag>
material | spatial
mesh | geometry | material | spatial
global:spatial | global:material | <coordsys_tag>
global:spatial | global:material | <coordsys_tag>
vector | vectorDensity | scalarFlux | directedAreaElement
MatrixTransform
model.component(<ctag>).common().create(<tag>,"MatrixTransform", <component>) creates a matrix transformation feature that transforms matrix indices from one coordinate system to another. For a MatrixTransform definition, the following properties are available.
none | raiseIndex | lowerIndex
full | symmetric
contravariant | covariant
mesh | geometry | material | spatial
global:spatial | global:material | <coordsys_tag>
contravariant | covariant
mesh | geometry | material | spatial
contravariant | covariant
mesh | geometry | material | spatial
global:spatial | global:material | <coordsys_tag>
global:spatial | global:material | <coordsys_tag>
global:spatial | global:material | <coordsys_tag>
material | spatial
material | spatial
mesh | geometry | material | spatial
global:spatial | global:material | <coordsys_tag>
mesh | geometry | material | spatial
global:spatial | global:material | <coordsys_tag>
global:spatial | global:material | <coordsys_tag>
vector | tensorDensity | vectorFlux
StateVariables
model.component(<ctag>).common().create(<tag>,"StateVariables") creates a state variable definition feature that declares state variables and specifies initialization and update expressions. For a State Variables definition, the following properties are available.
none | <quantity_id>
real | complex
Global Dependent Variables
model.component(<ctag>).common().create(<tag>,"GlobalDependentVariables") creates a global dependent variables definition feature that declares global degrees of freedom. For a Global Dependent Variables feature, the following properties are available.
none | <quantity_id>
off | solver | frequency
real | complex
Global Weak Contribution
model.component(<ctag>).common().create(<tag>,"GlobalWeakContribution") creates a global weak contribution feature that adds one or more global scalar weak expression to the overall system of equations. For a Global Weak Contribution feature, the following properties are available.
Global Constraint
model.component(<ctag>).common().create(<tag>,"GlobalConstraint") creates a global constraint feature that adds a single scalar constraint to the overall system of equations. For a Global Constraint feature, the following properties are available.
symmetric | userDefined
IntegrationRule
model.component(<ctag>).common().create(<tag>,"IntegrationRule") creates a custom integration rule feature that specifies the integration point locations and weights for all element shapes. For an Integration Rule feature the following properties are available:
Dependent Variable Field
model.component(<ctag>).common().create(<tag>,"DependentVariableField") creates a dependent variable field definition feature that declares a scalar or vector field on a selection. For a Dependent Variable field definition, the following properties are available.
on | off
on | off
mesh | geometry | material | spatial | allCovariant | allContravariant
{<field><x>, <field<y>, <field<z>}
on | off
all | mesh | geometry | material | spatial
scalar | inPlaneVector | outOfPlaneVector | threeComponentVector
0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | user defined
none | <quantity_id>
mesh | geometry | material | spatial
Frame in which the interiorFluxEstimate components are entered.
off | solver | frequency
real | complex
Weak Contribution
model.component(<ctag>).common().create(<tag>,"WeakContribution") creates a weak contribution feature that adds a weak expression on a selection to the overall system of equations. For a Weak Contribution feature, the following properties are available.
mesh | geometry | material | spatial
Constraint
model.component(<ctag>).common().create(<tag>,"Constraint") creates a constraint feature that adds a scalar or vector constraint on a selection. The constraint can be added to the overall system of equations as a pointwise constraint, a weak constraint, or be enforced by a penalty term. For a Constraint feature, the following properties are available.
elemental | nodal
pointwise | weak | Nitsche
symmetric | skew | nonsymmetric
0 | 2 | 4 | 6 | 8 | user defined
0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | user defined
auto | userDefined
mesh | geometry | material | spatial
symmetric | user defined
mesh | geometry | material | spatial
ControlVariableField
model.component(<ctag>).common().create(<tag>,"ControlVariableField") creates a control variable field feature that adds a control variable to some geometric entity for use in a sensitivity analysis. For a control variable field definition, the following properties are available, in addition to the Selections.
shlag | shdisc
true | false
ParticipationFactors
model.component(<ctag>).common().create(<tag>,"ParticipationFactors") creates a participation factors feature setting up variables for participation factor evaluation. For a ParticipationFactors definition, the following properties are available.
com | user
ResponseSpectrum
model.component(<ctag>).common().create(<tag>,"ResponseSpectrum") creates a response spectrum feature preparing a structural model for response spectrum evaluation. For a Response Spectrum feature, the following properties are available.
BucklingImperfection
model.component(<ctag>).common().create(<tag>,"BucklingImperfection") creates a buckling imperfection feature preparing a structural model for performing a buckling analysis with an initial imperfection based on a preceding linear buckling analysis. For a Buckling Imperfection feature, the following properties are available:
This feature requires a license for the Structural Mechanics Module.
P-Norm
model.component(<ctag>).common().create(<tag>,"PNorm") creates a P-norm feature which is differentiable approximation of maximum operator, which is particularly useful in the context of gradient-based optimization. For a P-norm feature, the following properties are available:
Determines whether 2πr is to be multiplied for axisymmetric models to mimic a volumetric integral.
Standard Deviation
model.component(<ctag>).common().create(<tag>,"StandardDeviation") creates a standard deviation which can be uses to quantify the variation over a selection. For a Standard Deviation feature, the following properties are available:
Determines whether 2πr is to be multiplied for axisymmetric models to mimic a volumetric integral.
This feature requires a license for the Structural Mechanics Module.
AmbientProperties
model.component(<ctag>).common().create(<tag>,"AmbientProperties") creates an ambient properties feature. Ambient properties can be set manually, or imported from meteorological data. For an Ambient Properties feature, Table 2-38 lists the properties that are available for the default setting of the AmbientData property.
UserDef | MeteorologicalData | MeteorologicalData2017
GlobalReducedModelInputs
model.component(<ctag>).common().create(<tag>,"GlobalReducedModelInputs") creates a reduced-model inputs feature defining control variables for use as inputs when training a reduced model. For a Global Reduced-Model Inputs feature definition, the following properties are available.
CommonInputDefault
The Common Model Inputs feature is a default singleton feature (with tag cminpt) that cannot be removed. It controls the default values of model input quantities required as input values to materials and physics features. For the Common Model Inputs definition, the following properties are available.
CommonInputDef
model.component(<ctag>).common().create(<tag>,"CommonInputDef") creates a common model input definition feature overriding the value of a model input quantity on a selection. For a Model Input definition, the following properties are available.
Note that changing the minpDefName property resets the corresponding value property to a default value specific to the particular quantity.
PrescribedDeformation
model.component(<ctag>).common().create(<tag>,"PrescribedDeformation") or model.component(<ctag>).common().create(<tag>,"PrescribedDeformationDeformedGeometry") creates a prescribed deformation feature acting on the spatial or material frame mesh, respectively. For a PrescribedDeformation definition, the following property is available.
PrescribedMeshVelocity
model.component(<ctag>).common().create(<tag>,"PrescribedMeshVelocity") or model.component(<ctag>).common().create(<tag>,"PrescribedMeshVelocityDeformedGeometry") creates a prescribed mesh velocity feature acting on the spatial or material frame mesh, respectively. For a PrescribedMeshVelocity definition, the following property is available.
RotatingDomain
model.component(<ctag>).common().create(<tag>,"RotatingDomain") or model.component(<ctag>).common().create(<tag>,"RotatingDomainDeformedGeometry") creates a rotating domain feature acting on the spatial or material frame mesh, respectively. For a RotatingDomain definition, the following properties are available.
The angular velocity when rotationType is set to rotationalVelocity.
The applied moment when rotationType is set to rigidBody.
The initial angle when rotationType is set to rotationalVelocity or rigidBody.
The initial angular velocity when rotationType is set to rigidBody.
The moment of inertia when rotationType is set to rigidBody.
The revolutions per time when rotationType is set to rotationalVelocity.
The rotational angle when rotationType is set to userDefined.
{"0", "0", "0"} (3D); {"0", "0"} (2D)
userDefined | rotationalVelocity | rigidBody
generalAngularVelocity | constantAngularVelocity | constantRevolutionsPerTime | generalRevolutionsPerTime
The rotational velocity expression to use when rotationType is set to rotationalVelocity.
DeformingDomain
model.component(<ctag>).common().create(<tag>,"DeformingDomain") or
model.component(<ctag>).common().create(<tag>,"DeformingDomainDeformedGeometry") creates a deforming domain feature acting on the spatial or material frame mesh, respectively. For a DeformingDomain definition, the following properties are available.
laplace | winslow | hyperelastic | yeoh
FixedBoundary
model.component(<ctag>).common().create(<tag>,"FixedBoundary") or model.component(<ctag>).common().create(<tag>,"FixedBoundaryDeformedGeometry") creates a fixed boundary feature acting on the spatial or material frame mesh, respectively. This feature has a boundary selection only.
PrescribedMeshDisplacement
model.component(<ctag>).common().create(<tag>,"PrescribedMeshDisplacement") or model.component(<ctag>).common()
  .create(
<tag>,"PrescribedMeshDisplacementDeformedGeometry") creates a prescribed mesh displacement feature acting on the spatial or material frame mesh, respectively. For a PrescribedMeshDisplacement definition, the following property is available.
PrescribedNormalMeshDisplacement
model.component(<ctag>).common().create(<tag>,"PrescribedNormalMeshDisplacement") or model.component(<ctag>).common()
  .create(
<tag>,"PrescribedNormalMeshDisplacementDeformedGeometry") creates a prescribed normal mesh displacement feature acting on the spatial or material frame mesh, respectively. For a PrescribedNormalMeshDisplacement definition, the following property is available.
PrescribedNormalMeshVelocity
model.component(<ctag>).common().create(<tag>,"PrescribedNormalMeshVelocity") or model.component(<ctag>).common()  .create(<tag>,"PrescribedNormalMeshVelocityDeformedGeometry") creates a prescribed normal mesh velocity feature acting on the spatial or material frame mesh, respectively. For a PrescribedNormalMeshVelocity definition, the following property is available.
RotatingBoundary
model.component(<ctag>).common().create(<tag>,"RotatingBoundary") or model.component(<ctag>).common().create(<tag>,"RotatingBoundaryDeformedGeometry") creates a rotating boundary feature acting on the spatial or material frame mesh, respectively. For a RotatingBoundary definition, the following properties are available.
The angular velocity when rotationType is set to rotationalVelocity.
The applied moment when rotationType is set to rigidBody.
The initial angle when rotationType is set to rotationalVelocity or rigidBody.
The initial angular velocity when rotationType is set to rigidBody.
The moment of inertia when rotationType is set to rigidBody.
The revolutions per time when rotationType is set to rotationalVelocity.
The rotational angle when rotationType is set to userDefined.
{"0", "0", "0"} (3D); {"0", "0"} (2D)
userDefined | rotationalVelocity | rigidBody
generalAngularVelocity | constantAngularVelocity | constantRevolutionsPerTime | generalRevolutionsPerTime
The rotational velocity expression to use when rotationType is set to rotationalVelocity.
Slip
model.component(<ctag>).common().create(<tag>,"Slip") or model.component(<ctag>).common().create(<tag>,"SlipDeformedGeometry") creates a mesh slip feature acting on the spatial or material frame mesh, respectively. This feature has a boundary selection only.
Symmetry
model.component(<ctag>).common().create(<tag>,"Symmetry") or model.component(<ctag>).common().create(<tag>,"SymmetryDeformedGeometry") creates a symmetry feature acting on the spatial or material frame mesh, respectively. This feature has a boundary selection only.
The ControlFunction, DensityTopology, FixedTopologyDomain, FixedTopologyBoundary, FreeShapeDomain, FreeShapeBoundary, FreeShapeShell, FreeShapeSymmetry, FixedShapeBoundary, FixedShapeEdge, FixedShapePoint, GlobalLeastSquaresObjective, LeastSquaresObjective, MaterialTopologyDomain, MaterialTopologyBoundary, PolynomialBoundary, PolynomialShell, VoidTopologyDomain, and VoidTopologyBoundary features below require the Optimization Module.
Control Function
model.component(<ctag>).common().create(<tag>,"ControlFunction") creates a control function feature for general optimization.
DensityTopology
model.component(<ctag>).common().create(<tag>,"DensityTopology") creates a density model feature for topology optimization.
FixedTopologyDomain
model.component(<ctag>).common().create(<tag>,"FixedTopologyDomain") creates a fixed topology domain feature for topology optimization.
FixedTopologyBoundary
model.component(<ctag>).common().create(<tag>,"FixedTopologyBoundary") creates a fixed topology boundary feature for topology optimization.
FreeShapeDomain
model.component(<ctag>).common().create(<tag>,"FreeShapeDomain") creates a free shape domain feature for shape optimization.
Transformation
model.component(<ctag>).common().create(<tag>,"Transformation") creates a transformation feature for shape optimization.
FreeShapeBoundary
model.component(<ctag>).common().create(<tag>,"FreeShapeBoundary") creates a fixed shape boundary feature for shape optimization.
FreeShapeShell
model.component(<ctag>).common().create(<tag>,"FreeShapeShell") creates a free shape shell feature for shape optimization.
PolynomialShell
model.component(<ctag>).common().create(<tag>,"PolynomialShell") creates a polynomial shell feature for shape optimization.
FreeShapeSymmetry
model.component(<ctag>).common().create(<tag>,"FreeShapeSymmetry") creates a free shape symmetry feature for shape optimization.
FixedShapePoint
model.component(<ctag>).common().create(<tag>,"FixedShapePoint") creates a fixed shape point feature for shape optimization in 2D only.
FixedShapeEdge
model.component(<ctag>).common().create(<tag>,"FixedShapeEdge") creates a fixed shape edge feature for shape optimization in 3D only.
FixedShapeBoundary
model.component(<ctag>).common().create(<tag>,"FixedShapeBoundary") creates a fixed shape boundary feature for shape optimization.
MirrorShape
model.component(<ctag>).common().create(<tag>,"MirrorShape") creates a mirror shape feature for shape optimization.
SectorShape
model.component(<ctag>).common().create(<tag>,"SectorShape") creates a sector shape boundary feature for shape optimization.
GlobalLeastSquaresObjective
model.component(<ctag>).common().create(<tag>,"GlobalLeastSquaresObjective") creates a global least-squares objective.
LeastSquaresObjective
model.component(<ctag>).common().create(<tag>,"LeastSquaresObjective") creates a least-squares objective.
MaterialTopologyDomain
model.component(<ctag>).common().create(<tag>,"MaterialTopologyDomain") creates a material topology domain feature for topology optimization.
MaterialTopologyBoundary
model.component(<ctag>).common().create(<tag>,"MaterialTopologyBoundary") creates a material topology boundary feature for topology optimization.
PolynomialBoundary
model.component(<ctag>).common().create(<tag>,"PolynomialBoundary") creates a polynomial boundary feature for shape optimization in 2D only.
Transformation
model.component(<ctag>).common().create(<tag>,"Transformation") creates a linear shape domain feature for shape optimization.
VoidTopologyDomain
model.component(<ctag>).common().create(<tag>,"VoidTopologyDomain") creates a void topology domain feature for topology optimization.
VoidTopologyBoundary
model.component(<ctag>).common().create(<tag>,"VoidTopologyBoundary") creates a void topology boundary feature for topology optimization.
MirrorTopology
model.component(<ctag>).common().create(<tag>,"MirrorTopology") creates a mirror symmetry feature for topology optimization.
SectorTopology
model.component(<ctag>).common().create(<tag>,"SectorTopology") creates a sector symmetry feature for topology optimization.
The following properties are available for the common optimization features.
The projection slope when projectionType is set to TanhProjection.
linear | constant
Helmholtz | No_filter
Mesh | Custom
L_min is taken as h when filterLengthType is set to Mesh.
Small | Medium | Large | Custom
L_min is taken as 1, 1.5, and 2 times the maximumDisplacement, when the filterRadiusType is set to Small, Medium, and Large, respectively.
Custom | Material | Void
theta_fix is taken as 0 when fixedDensityType is set to Void, and it is taken as 0 when fixedDensityType is set to Material.
SIMP | Darcy | Linear_interp | RAMP | Custom
Filter radius when filterType is set to Helmholtz.
SIMP exponent, when interpolationType is set to SIMP.
Darcy interpolation, when interpolationType is set to Darcy.
RAMP parameter, when interpolationType is set to RAMP.
Auto | Custom
p_SIMP is taken as 3, when setsimpExponentType is set to Auto.
Auto | Custom
theta_min is taken as 0.001 when thetaMinType is set to Auto.
The projection point when projectionType is set to TanhProjection.
Minimum penalized volume fraction, when interpolationType is set to SIMP.
bernstein | lagrange
SurrogateModelGeometrySampling
model.component(<ctag>).common().create(<tag>,"SurrogateModelGeometrySampling") creates a geometry sampling feature for surrogate model training.
The following properties are available for a SurrogateModelGeometrySampling definition:
selection | grid | mesh
mesh | geometry | material | spatial
The selection to use when samplemethod is set to selection.
The mesh to interpolate on when samplemethod is set to mesh.