SimLoadRecipe Class — NXOpen Python API Reference 12.0.0 documentation

# SimLoadRecipe Class

class `NXOpen.CAE.``SimLoadRecipe`

  Bases: `NXOpen.TaggedObject`, `NXOpen.CAE.IPostScenarioDataSource`

  This is the class handling the attributes of a load recipe.

  To create a new instance of this class, use `NXOpen.CAE.SimLoadRecipeCollection.Create()`

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
DataType | Returns the data type of a `NXOpen.CAE.SimLoadRecipe`
Description | Returns or sets the description of a `NXOpen.CAE.SimLoadRecipe`.
Name | Returns or sets the name of a `NXOpen.CAE.SimLoadRecipe`.
Tag | Returns the Tag for this object.
MappingCollection | Returns the `NXOpen.CAE.SimLoadRecipeMappingCollection`.
SourceCollection | Contains a `NXOpen.CAE.SimLoadRecipeSourceCollection`.

# Methods

Method | Description
--- | ---
Autofill | Fills the mapping tables of the load recipe based on available functions in the data sources.
DisableLoadCondition | Disables a load condition in the Load Recipe.
DisableTrackingValue | Disables a tracking value in the Load Recipe.
EnableLoadCondition | Enables a load condition in the Load Recipe.
EnableTrackingValue | Enables a tracking value in the Load Recipe.
ExportToCSVFile | Exports mapping entries to a CSV file.
GetLoadConditionHandlingType | Gets the type of load conditions handling of the `NXOpen.CAE.SimLoadRecipe`
GetLoadConditions | Gets the load condition strings declared in the `NXOpen.CAE.SimLoadRecipe`
GetTrackingValues | Gets the tracking value strings declared in the `NXOpen.CAE.SimLoadRecipe`
ImportFromCSVFile | Imports mapping entries from a CSV file.
LoadLoadConditions | Loads all the load conditions available in the data sources and enables them.
LoadTrackingValues | Loads all the tracking values available in the data sources and enables them.
NewLbcGeneratorFromLoadRecipe | Creates a new `NXOpen.CAE.SimLoadRecipeLbcGenerator`.
SetAutofillAssemblyComponent | Set the assembly component on which the autofill method operates on.
SetLoadConditionHandlingType | Sets the type of load conditions handling of the `NXOpen.CAE.SimLoadRecipe`
Validation | Validation of the Load Recipe

# Property Detail

## DataType

`SimLoadRecipe.``DataType`

  Returns the data type of a `NXOpen.CAE.SimLoadRecipe`

  `-------------------------------------`

  Getter Method

  Signature `DataType`

  Returns: |
  Return type: | `NXOpen.CAE.SimLoadRecipeTypesDataTypes`

  New in version NX10.0.0.

  License requirements: None.

## Description

`SimLoadRecipe.``Description`

  Returns or sets the description of a `NXOpen.CAE.SimLoadRecipe`.

  `-------------------------------------`

  Getter Method

  Signature `Description`

  Returns: |
  Return type: | str

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Description`

  Parameters: | description (str) –

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Name

`SimLoadRecipe.``Name`

  Returns or sets the name of a `NXOpen.CAE.SimLoadRecipe`.

  `-------------------------------------`

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Name`

  Parameters: | name (str) –

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## MappingCollection

`SimLoadRecipe.``MappingCollection`

  Returns the `NXOpen.CAE.SimLoadRecipeMappingCollection`.

  Signature `MappingCollection`

  New in version NX10.0.0.

  Returns: |
  Return type: | `NXOpen.CAE.SimLoadRecipeMappingCollection`

## SourceCollection

`SimLoadRecipe.``SourceCollection`

  Contains a `NXOpen.CAE.SimLoadRecipeSourceCollection`.

  Signature `SourceCollection`

  New in version NX10.0.0.

  Returns: |
  Return type: | `NXOpen.CAE.SimLoadRecipeSourceCollection`

# Method Detail

## Autofill

`SimLoadRecipe.``Autofill`

  Overloaded method Autofill

  - `Autofill()`
  - `Autofill(feModelOcc)`

  `-------------------------------------`

  Fills the mapping tables of the load recipe based on available functions in the data sources.

  Creates and adds `NXOpen.CAE.SimLoadRecipeMapEntry` instances to the load recipe. Sets the value of `NXOpen.CAE.SimLoadRecipeMapEntry.Target`()` for each map entry to the entity label read from the data sources. This method doesn’t create entries with `NXOpen.CAE.SimLoadRecipeMapEntry.TargetType`()` which refer to groups or meshes.

  The parameters available in the data sources are filled for each entry in the following format: “ME:<target label>”.

  Signature `Autofill()`

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

  `-------------------------------------`

  Overload to specify a component of the FEM assembly for which to autofill the mapping tables.

  Signature `Autofill(feModelOcc)`

  Parameters: | feModelOcc (`NXOpen.CAE.FEModelOccurrence`) –

  New in version NX11.0.0.

  Deprecated since version NX12.0.0: Use `NXOpen.CAE.SimLoadRecipe.Autofill()` instead.

  License requirements: nx_masterfem (“Finite Element Modeling”)

  `-------------------------------------`

## DisableLoadCondition

`SimLoadRecipe.``DisableLoadCondition`

  Disables a load condition in the Load Recipe.

  Disabled load conditions will not be used when creating a solution from load recipe.

  Signature `DisableLoadCondition(loadCondition)`

  Parameters: | loadCondition (str) –

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## DisableTrackingValue

`SimLoadRecipe.``DisableTrackingValue`

  Disables a tracking value in the Load Recipe.

  Disabled tracking values will not be used when creating a solution from load recipe.

  Signature `DisableTrackingValue(trackingValue)`

  Parameters: | trackingValue (str) –

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EnableLoadCondition

`SimLoadRecipe.``EnableLoadCondition`

  Enables a load condition in the Load Recipe.

  Only enabled load conditions will be used when creating a solution from load recipe.

  Signature `EnableLoadCondition(loadCondition)`

  Parameters: | loadCondition (str) –

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EnableTrackingValue

`SimLoadRecipe.``EnableTrackingValue`

  Enables a tracking value in the Load Recipe.

  Only enabled tracking values will be used when creating a solution from load recipe.

  Signature `EnableTrackingValue(trackingValue)`

  Parameters: | trackingValue (str) –

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## ExportToCSVFile

`SimLoadRecipe.``ExportToCSVFile`

  Exports mapping entries to a CSV file.

  Signature `ExportToCSVFile(filePath)`

  Parameters: | filePath (str) – Path of the CSV file
  Returns: | True if the mapping table entries contain the CSV delimiter character.

  If this is true, it will cause inconsistencies when importing the file. :rtype: bool

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## GetLoadConditionHandlingType

`SimLoadRecipe.``GetLoadConditionHandlingType`

  Gets the type of load conditions handling of the `NXOpen.CAE.SimLoadRecipe`

  Signature `GetLoadConditionHandlingType()`

  Returns: |
  Return type: | `NXOpen.CAE.SimLoadRecipeTypesLoadConditionHandling`

  New in version NX10.0.0.

  License requirements: None.

## GetLoadConditions

`SimLoadRecipe.``GetLoadConditions`

  Gets the load condition strings declared in the `NXOpen.CAE.SimLoadRecipe`

  Signature `GetLoadConditions()`

  Returns: |
  Return type: | list of str

  New in version NX11.0.0.

  License requirements: None.

## GetTrackingValues

`SimLoadRecipe.``GetTrackingValues`

  Gets the tracking value strings declared in the `NXOpen.CAE.SimLoadRecipe`

  Signature `GetTrackingValues()`

  Returns: |
  Return type: | list of str

  New in version NX11.0.0.

  License requirements: None.

## ImportFromCSVFile

`SimLoadRecipe.``ImportFromCSVFile`

  Imports mapping entries from a CSV file.

  Signature `ImportFromCSVFile(filePath, csvDelim)`

  Parameters:

  - filePath (str) – Path of the CSV file
  - csvDelim (str) – Delimiter character used in the CSV file. If None, the comma character will be used. If this string contains more then one character, only the first one will be used.

  Returns: | a tuple
  Return type: | A tuple consisting of (noParsedContent, invalidLoadType, invalidEntityType, invalidNbrOfParameters) noParsedContent is a bool. True if no valid data could be parsed from the file. invalidLoadType is a bool. True if an invalid load type was found. All data for this load type will be ignored. invalidEntityType is a bool. True if an invalid entity type was found. The entities with invalid entity type will be ignored. invalidNbrOfParameters is a bool. True if an invalid number of parameters was found for an entry. If the number of parameters is less then expected, it will populate the first values for which it has values. If the number of parameters is more then expected, the last values will be ignored.

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## LoadLoadConditions

`SimLoadRecipe.``LoadLoadConditions`

  Loads all the load conditions available in the data sources and enables them.

  Signature `LoadLoadConditions()`

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## LoadTrackingValues

`SimLoadRecipe.``LoadTrackingValues`

  Loads all the tracking values available in the data sources and enables them.

  Signature `LoadTrackingValues()`

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## NewLbcGeneratorFromLoadRecipe

`SimLoadRecipe.``NewLbcGeneratorFromLoadRecipe`

  Creates a new `NXOpen.CAE.SimLoadRecipeLbcGenerator`.

  Signature `NewLbcGeneratorFromLoadRecipe()`

  Returns: |
  Return type: | `NXOpen.CAE.SimLoadRecipeLbcGenerator`

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## SetAutofillAssemblyComponent

`SimLoadRecipe.``SetAutofillAssemblyComponent`

  Set the assembly component on which the autofill method operates on.

  Signature `SetAutofillAssemblyComponent(feModelOcc)`

  Parameters: | feModelOcc (`NXOpen.CAE.FEModelOccurrence`) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## SetLoadConditionHandlingType

`SimLoadRecipe.``SetLoadConditionHandlingType`

  Sets the type of load conditions handling of the `NXOpen.CAE.SimLoadRecipe`

  Signature `SetLoadConditionHandlingType(lcHandling)`

  Parameters: | lcHandling (`NXOpen.CAE.SimLoadRecipeTypesLoadConditionHandling`) –

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Validation

`SimLoadRecipe.``Validation`

  Validation of the Load Recipe

  Signature `Validation()`

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)