Class FESubstructure

Inheritance
System.Object
System.MarshalByRefObject
SMT.MastaAPIUtility.MarshalByRefObjectPermanent
APIBase
FEStiffness
FESubstructure
Implements
System.IEquatable<APIBase>
Inherited Members
SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
Namespace: SMT.MastaAPI.SystemModel.FE
Assembly: SMT.MastaAPI.13.0.dll
Syntax
public class FESubstructure : FEStiffness, IEquatable<APIBase>

Properties

AcousticRadiationEfficiency

Declaration
public AcousticRadiationEfficiency AcousticRadiationEfficiency { get; }
Property Value
Type Description
AcousticRadiationEfficiency

ActualNumberOfRigidBodyModes

Calculated from a modal analysis of the reduced stiffness and mass matrices using the specified tolerance for zero frequency.

Declaration
public int ActualNumberOfRigidBodyModes { get; }
Property Value
Type Description
System.Int32

AlignmentMethod

Determines the method used to align the FE Substructure with the MASTA model.

Declaration
public AlignmentMethod AlignmentMethod { get; set; }
Property Value
Type Description
AlignmentMethod

AlignmentToComponent

Declaration
public RelativeComponentAlignment<Component> AlignmentToComponent { get; }
Property Value
Type Description
RelativeComponentAlignment<Component>

AlignmentUsingAxialNodePositions

Declaration
public AlignmentUsingAxialNodePositions AlignmentUsingAxialNodePositions { get; }
Property Value
Type Description
AlignmentUsingAxialNodePositions

AngleSpan

The difference angle between the first and last angle. This should be set to according to the symmetry of your FE Substructure.

Measurement: Angle

Declaration
public double AngleSpan { get; set; }
Property Value
Type Description
System.Double

AngularAlignmentTolerance

Measurement: Angle

Declaration
public double AngularAlignmentTolerance { get; set; }
Property Value
Type Description
System.Double

ApplyTranslationAndRotationForPlanetaryDuplicates

If set to false, only a translation will be applied.

Declaration
public bool ApplyTranslationAndRotationForPlanetaryDuplicates { get; set; }
Property Value
Type Description
System.Boolean

AreVectorsLoaded

Declaration
public bool AreVectorsLoaded { get; }
Property Value
Type Description
System.Boolean

BearingNodeAlignment

Bearing nodes should be connected to the region of the FE Substructure that corresponds to the bearing race only. The position of the node is used to align the FE with the MASTA model. This setting indicates the position of the node in the FE Substructure with relation to the bearing.

Declaration
public BearingNodeAlignmentOption BearingNodeAlignment { get; set; }
Property Value
Type Description
BearingNodeAlignmentOption

BearingRacesInFE

Specifies whether the rolling bearing races that are connected to the FE Substructure are included in the FE geometry or not. Is used to determine what additional mass is required at the bearing location. Can be overridden on each bearing connection.

Declaration
public bool BearingRacesInFE { get; set; }
Property Value
Type Description
System.Boolean

CheckFEHasInternalModesBeforeNVHAnalysis

This FE model has no internal modes, which can cause problems for dynamic analyses. To allow NVH analyses to run with this FE active, deselect this option.

Declaration
public bool CheckFEHasInternalModesBeforeNVHAnalysis { get; set; }
Property Value
Type Description
System.Boolean

CMSModel

Declaration
public CMSModel CMSModel { get; }
Property Value
Type Description
CMSModel

Comment

Declaration
public string Comment { get; set; }
Property Value
Type Description
System.String

ComponentToAlignTo

Declaration
public ListWithSelectedItem<Component> ComponentToAlignTo { get; set; }
Property Value
Type Description
ListWithSelectedItem<Component>

CondensationNodeSize

Nodes are drawn in 3D view with this diameter

Measurement: ShortLength

Declaration
public double CondensationNodeSize { get; set; }
Property Value
Type Description
System.Double

CoordinateSystem

Declaration
public CoordinateSystem3D CoordinateSystem { get; }
Property Value
Type Description
CoordinateSystem3D

Datum

The datum in the MASTA model that represents the FE coordinate system.

Declaration
public ListWithSelectedItem<Datum> Datum { get; set; }
Property Value
Type Description
ListWithSelectedItem<Datum>

DistanceDisplayUnit

Affects the display of the reduced matrices (e.g. stiffness) does not modify the values.

Declaration
public ListWithSelectedItem<Unit> DistanceDisplayUnit { get; set; }
Property Value
Type Description
ListWithSelectedItem<Unit>

ExpectedNumberOfRigidBodyModes

The number of rigid body modes the FE is expected to have. Defaults to 6 for shafts and ungrounded housings, and 0 for grounded housings. This should be overridden in special cases where a different number is expected.

Declaration
public Overridable<int> ExpectedNumberOfRigidBodyModes { get; set; }
Property Value
Type Description
Overridable<System.Int32>

Export

Declaration
public FESubstructureExportOptions Export { get; }
Property Value
Type Description
FESubstructureExportOptions

ExternalFEForcesAreFromGravityOnly

If this option is selected, a check is done when running the analysis to check whether the load vector imported is in the same direction as the gravity vector specified in MASTA. Further, the 'Include Gravity?' property on the analysis settings allows to include the vector or not. If this option is not selected, the load vector is always included in the analysis and no check is done on its direction.

Declaration
public bool ExternalFEForcesAreFromGravityOnly { get; set; }
Property Value
Type Description
System.Boolean

FEMeshingOptions

Declaration
public ShaftFEMeshingOptions FEMeshingOptions { get; }
Property Value
Type Description
ShaftFEMeshingOptions

FEPart

Declaration
public FEPart FEPart { get; }
Property Value
Type Description
FEPart

ForceDisplayUnit

Affects the display of the reduced matrices (e.g. stiffness) does not modify the values.

Declaration
public ListWithSelectedItem<Unit> ForceDisplayUnit { get; set; }
Property Value
Type Description
ListWithSelectedItem<Unit>

FullFEModelMeshPath

The current save location of the FE model mesh if it is not stored within the MASTA file.

Declaration
public string FullFEModelMeshPath { get; }
Property Value
Type Description
System.String

FullFEModelMeshSize

For embedded meshes, this is approximate and based on the number of nodes and elements in the FE model.

Declaration
public string FullFEModelMeshSize { get; }
Property Value
Type Description
System.String

FullFEModelVectorsPath

The current save location of the FE model expansion vectors if it is not stored within the MASTA file.

Declaration
public string FullFEModelVectorsPath { get; }
Property Value
Type Description
System.String

FullFEModelVectorsSize

Declaration
public string FullFEModelVectorsSize { get; }
Property Value
Type Description
System.String

GearMeshingOptions

Declaration
public ReadOnlyCollection<GearMeshingOptions> GearMeshingOptions { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<GearMeshingOptions>

Geometries

Declaration
public ReadOnlyCollection<FEStiffnessGeometry> Geometries { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<FEStiffnessGeometry>

GeometryMeshingMaterial

Used for creation of full FE mesh from imported geometry.

Declaration
public DatabaseWithSelectedItem GeometryMeshingMaterial { get; set; }
Property Value
Type Description
DatabaseWithSelectedItem

GeometryModellerDesignInformation

Declaration
public GeometryModellerDesignInformation GeometryModellerDesignInformation { get; }
Property Value
Type Description
GeometryModellerDesignInformation

GeometryModellerDimensions

Declaration
public GeometryModellerDimensions GeometryModellerDimensions { get; }
Property Value
Type Description
GeometryModellerDimensions

GravityForceCanBeRotated

The gravity force acting on each node is specified for this FE Substructure in each principal degree of freedom of the FE Substructure. If this is not the case, then care must be taken to ensure that the direction of gravity specified in the FE package and the direction of gravity in MASTA are consistent.

Declaration
public bool GravityForceCanBeRotated { get; }
Property Value
Type Description
System.Boolean

GravityForceSource

The gravity force acting on each node is specified for this FE Substructure.

Declaration
public GravityForceSource GravityForceSource { get; }
Property Value
Type Description
GravityForceSource

GravityMagnitudeUsedForReducedForces

The magnitude of the acceleration used when calculating the reduced gravity vector during the FE reduction.

Declaration
public double GravityMagnitudeUsedForReducedForces { get; set; }
Property Value
Type Description
System.Double

HousingIsGrounded

Is the housing grounded directly in the FE?

Declaration
public bool HousingIsGrounded { get; set; }
Property Value
Type Description
System.Boolean

IndependentMastaCreatedCondensationNodes

Declaration
public ReadOnlyCollection<IndependentMASTACreatedCondensationNode> IndependentMastaCreatedCondensationNodes { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<IndependentMASTACreatedCondensationNode>

IsHousing

Determines whether the FE Substructure will be replacing fixed or rotating components. If this option is not selected, it will not be possible to connect the FE Substructure to the grounded races of bearings or other connectors.

Declaration
public bool IsHousing { get; set; }
Property Value
Type Description
System.Boolean

IsMeshLoaded

Declaration
public bool IsMeshLoaded { get; }
Property Value
Type Description
System.Boolean
Declaration
public ReadOnlyCollection<FELink> Links { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<FELink>

Material

Used for calculation of bearing fitting and thermal effects, the default material of Detailed Splines and to calculate the thermal expansion of the FE Substructure when using the uniform expansion option.

Declaration
public DatabaseWithSelectedItem Material { get; set; }
Property Value
Type Description
DatabaseWithSelectedItem

Name

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

Nodes

Declaration
public ReadOnlyCollection<FESubstructureNode> Nodes { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<FESubstructureNode>

NonCondensationNodeSize

Non-condensation nodes are drawn in 3D view with this diameter in pixels

Declaration
public int NonCondensationNodeSize { get; set; }
Property Value
Type Description
System.Int32

NumberOfAngles

The number of angle options in the resulting FE Substructure and the number of nodes that will be created.

Declaration
public int NumberOfAngles { get; set; }
Property Value
Type Description
System.Int32

NumberOfCondensationNodes

The number of condensation nodes in the current FE model. This may be different to the number in the current stiffness matrix if nodes are created in MASTA and the settings have changed since the reduction was run.

Declaration
public int NumberOfCondensationNodes { get; }
Property Value
Type Description
System.Int32

NumberOfCondensationNodesInReducedModel

The number of nodes in the current reduced stiffness, mass, etc.

Declaration
public int NumberOfCondensationNodesInReducedModel { get; }
Property Value
Type Description
System.Int32

PolarInertia

Calculated for rotation about the axis of a replaced shaft

Measurement: Inertia

Declaration
public double PolarInertia { get; }
Property Value
Type Description
System.Double

ReducedStiffnessFile

Declaration
public string ReducedStiffnessFile { get; }
Property Value
Type Description
System.String

ReducedStiffnessFileEditable

Declaration
public string ReducedStiffnessFileEditable { get; set; }
Property Value
Type Description
System.String

ReplacedShafts

Declaration
public ReadOnlyCollection<Shaft> ReplacedShafts { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<Shaft>

ShaftsThatCanBeReplaced

Declaration
public ReadOnlyCollection<ReplacedShaftSelectionHelper> ShaftsThatCanBeReplaced { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<ReplacedShaftSelectionHelper>

SoundPressureEnclosure

Declaration
public SoundPressureEnclosure SoundPressureEnclosure { get; }
Property Value
Type Description
SoundPressureEnclosure

ThermalExpansionDisplacements

Declaration
public ReadOnlyCollection<VectorWithLinearAndAngularComponents> ThermalExpansionDisplacements { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<VectorWithLinearAndAngularComponents>

ThermalExpansionForces

Declaration
public ReadOnlyCollection<VectorWithLinearAndAngularComponents> ThermalExpansionForces { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<VectorWithLinearAndAngularComponents>

ThermalExpansionOption

Specify how thermal expansion is included for this FE

Declaration
public EnumWithSelectedValue<ThermalExpansionOption> ThermalExpansionOption { get; set; }
Property Value
Type Description
EnumWithSelectedValue<ThermalExpansionOption>

TorqueTransmissionRelativeTolerance

Controls the maximum allowable error in the torque transmission of the FE Substructure when checking for validity.

Measurement: Percentage

Declaration
public double TorqueTransmissionRelativeTolerance { get; set; }
Property Value
Type Description
System.Double

Type

Determines the options that are available

Declaration
public EnumWithSelectedValue<FESubstructureType> Type { get; set; }
Property Value
Type Description
EnumWithSelectedValue<FESubstructureType>

Methods

AddGeometry()

Import representative geometry of the FE from a VRML or STL file. Geometry is used for visualisation purposes only and will not deform.

Declaration
public void AddGeometry()

AutoConnectExternalNodes()

Searches for FE nodes that are in the correct location for components to connect to.

Declaration
public void AutoConnectExternalNodes()

ConvertShaftsToFE(FEMeshingOperation, String)

Declaration
public void ConvertShaftsToFE(FEMeshingOperation operation, string exportFileName)
Parameters
Type Name Description
FEMeshingOperation operation
System.String exportFileName

CopyDatumToManual()

Copy the orientation of the selected datum to manual mode.

Declaration
public void CopyDatumToManual()

CreateDatumFromManualAlignment()

Declaration
public void CreateDatumFromManualAlignment()

CreateFESubstructureWithSelectionComponents()

Declaration
public FESubstructureWithSelectionComponents CreateFESubstructureWithSelectionComponents()
Returns
Type Description
FESubstructureWithSelectionComponents

CreateFESubstructureWithSelectionForHarmonicAnalysis()

Declaration
public FESubstructureWithSelectionForHarmonicAnalysis CreateFESubstructureWithSelectionForHarmonicAnalysis()
Returns
Type Description
FESubstructureWithSelectionForHarmonicAnalysis

CreateFESubstructureWithSelectionForModalAnalysis()

Declaration
public FESubstructureWithSelectionForModalAnalysis CreateFESubstructureWithSelectionForModalAnalysis()
Returns
Type Description
FESubstructureWithSelectionForModalAnalysis

CreateFESubstructureWithSelectionForStaticAnalysis()

Declaration
public FESubstructureWithSelectionForStaticAnalysis CreateFESubstructureWithSelectionForStaticAnalysis()
Returns
Type Description
FESubstructureWithSelectionForStaticAnalysis

CreateFEVolumeMesh()

Create the FE volume mesh

Declaration
public void CreateFEVolumeMesh()

DefaultNodeCreationOptions()

For a full FE mesh this will set default settings to create condensation nodes automatically if a connection has not already been modified.

Declaration
public void DefaultNodeCreationOptions()

If a link uses existing condensation nodes, then this will remove nodes for that link.

Declaration
public void DeleteAllLinks()

Duplicate(String)

Declaration
public FESubstructure Duplicate(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
FESubstructure

EmbedFEModelMeshInMASTAFile()

Store the FE model mesh as part of the MASTA file. Recommended for small FE models as is more convenient.

Declaration
public void EmbedFEModelMeshInMASTAFile()

EmbedFEModelVectorsInMASTAFile()

Store the FE model expansion vectors as part of the MASTA file. Recommended for small FE models as is more convenient.

Declaration
public void EmbedFEModelVectorsInMASTAFile()

ImportFEMesh(String, FEExportFormat, Double, Double, TaskProgress)

Declaration
public void ImportFEMesh(string filePath, FEExportFormat format, double lengthScale = 1, double forceScale = 1, TaskProgress progress = null)
Parameters
Type Name Description
System.String filePath
FEExportFormat format
System.Double lengthScale
System.Double forceScale
SMT.MastaAPIUtility.TaskProgress progress

ImportNodePositions(String, Unit)

Declaration
public void ImportNodePositions(string fileName, Unit distanceUnit)
Parameters
Type Name Description
System.String fileName
Unit distanceUnit

ImportReducedStiffness(String, Unit, Unit)

Declaration
public void ImportReducedStiffness(string fileName, Unit distanceUnit, Unit forceUnit)
Parameters
Type Name Description
System.String fileName
Unit distanceUnit
Unit forceUnit

LinksFor(FESubstructureNode)

Declaration
public ReadOnlyCollection<FELink> LinksFor(FESubstructureNode node)
Parameters
Type Name Description
FESubstructureNode node
Returns
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<FELink>

LoadExistingMastaFEFile(String)

Declaration
public void LoadExistingMastaFEFile(string fileName)
Parameters
Type Name Description
System.String fileName

LoadExistingMastaFEFile(String, TaskProgress)

Declaration
public void LoadExistingMastaFEFile(string fileName, TaskProgress progress)
Parameters
Type Name Description
System.String fileName
SMT.MastaAPIUtility.TaskProgress progress

LoadExternalMesh(String)

Declaration
public void LoadExternalMesh(string filePath)
Parameters
Type Name Description
System.String filePath

LoadExternalVectors(String)

Declaration
public void LoadExternalVectors(string filePath)
Parameters
Type Name Description
System.String filePath

LoadStlGeometry(Unit, String)

Declaration
public void LoadStlGeometry(Unit lengthUnit, string fileName)
Parameters
Type Name Description
Unit lengthUnit
System.String fileName

PerformReduction()

Calculate the reduced stiffness, mass, etc. for use in other MASTA analysis modes.

Declaration
public void PerformReduction()

ReImportExternalFEMesh()

Re-import the full FE mesh, reusing file path and previous settings. Note that the existing full FE mesh will be overwritten.

Declaration
public void ReImportExternalFEMesh()

RemoveFullFEMesh()

Removes the FE mesh from the FE Substructure so that it will behave as an FE Substructure that was reduced by an external program. The calculated stiffness and mass will be retained.

Declaration
public void RemoveFullFEMesh()

RereadMeshFromGeometryModeller()

Requests latest mesh from Geometry Modeller

Declaration
public void RereadMeshFromGeometryModeller()

StoreFullFeMeshInExternalFile(String)

Declaration
public void StoreFullFeMeshInExternalFile(string externalFePath)
Parameters
Type Name Description
System.String externalFePath

StoreFullFeModelVectorsInExternalFile(String)

Declaration
public void StoreFullFeModelVectorsInExternalFile(string externalFePath)
Parameters
Type Name Description
System.String externalFePath

UnloadExternalMeshFile()

Unload an externally stored '.smtfem' file to liberate memory while it is not required.

Declaration
public void UnloadExternalMeshFile()

UnloadExternalVectorsFile()

Unload an externally stored '.smtfev' file to liberate memory while it is not required.

Declaration
public void UnloadExternalVectorsFile()

UpdateGearTeethMesh()

Modify the imported full FE to include MASTA-generated meshes of the selected gears.

Declaration
public void UpdateGearTeethMesh()

Implements

System.IEquatable<T>

Extension Methods