SimLoadRecipeLbcGenerator Class — NXOpen Python API Reference 12.0.0 documentation

# SimLoadRecipeLbcGenerator Class

class `NXOpen.CAE.``SimLoadRecipeLbcGenerator`

  Bases: `NXOpen.TransientObject`

  Handles generation of subcases and loads based on a `NXOpen.CAE.SimLoadRecipe`.

  An instance of this class can be obtained from `NXOpen.CAE.SimLoadRecipe`.

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

  New in version NX10.0.0.

# Methods

Method | Description
--- | ---
Dispose | Frees the object from memory.
Generate | Generates Loads at solution level.
GetAllowedStepTypeCount | Gets the count of allowable step types when generating steps for a solution from a load recipe.

# Enumerations

SimLoadRecipeLbcGeneratorLbcHierarchyTypes Enumeration | This enum defines the hierarchy type of LBCs to be created by this `NXOpen.CAE.SimLoadRecipeLbcGenerator`.

# Method Detail

## Dispose

`SimLoadRecipeLbcGenerator.``Dispose`

  Frees the object from memory.

  After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

  Signature `Dispose()`

  New in version NX10.0.0.

  License requirements: None.

## Generate

`SimLoadRecipeLbcGenerator.``Generate`

  Overloaded method Generate

  - `Generate(solution)`
  - `Generate(solution, stepType)`
  - `Generate(solution, lbcHierarchyType)`
  - `Generate(solution, stepType, lbcHierarchyType)`

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

  Generates Loads at solution level. This method supports creation of loads for a single subcase (load condition or combination of load condition and tracking value). All Loads will be created in the loads container of the solution. No steps will be created or added to the solution.

  The solver language of the solution defines what kind of Loads, Constraints and/or Load Sets will be generated for each load type.

  Signature `Generate(solution)`

  Parameters: | solution (`NXOpen.CAE.SimSolution`) –

  New in version NX10.0.0.

  Deprecated since version NX11.0.0: Use method taking LBC hierarchy type as input. This method always creates separated LBCs.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Generates Loads at the level of solution steps. This method creates a solution step for every available subcase (load condition or combination of load condition and tracking value) from the load recipe. Loads will be created in the loads container of each created solution step.

  The solver language of the solution defines what kind of Loads, Constraints and/or Load Sets will be generated for each load type.

  Signature `Generate(solution, stepType)`

  Parameters:

  - solution (`NXOpen.CAE.SimSolution`) –
  - stepType (int) –

  New in version NX10.0.0.

  Deprecated since version NX11.0.0: Use method taking LBC hierarchy type as input. This method always creates separated LBCs.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Generates Loads at solution level. This method supports creation of loads for a single subcase (load condition or combination of load condition and tracking value). All Loads will be created in the loads container of the solution. No steps will be created or added to the solution.

  The solver language of the solution defines what kind of Loads, Constraints and/or Load Sets will be generated for each load type.

  Signature `Generate(solution, lbcHierarchyType)`

  Parameters:

  - solution (`NXOpen.CAE.SimSolution`) –
  - lbcHierarchyType (`NXOpen.CAE.SimLoadRecipeLbcGeneratorLbcHierarchyTypes`) –

  New in version NX11.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Generates Loads at the level of solution steps. This method creates a solution step for every available subcase (load condition or combination of load condition and tracking value) from the load recipe. Loads will be created in the loads container of each created solution step.

  The solver language of the solution defines what kind of Loads, Constraints and/or Load Sets will be generated for each load type.

  Signature `Generate(solution, stepType, lbcHierarchyType)`

  Parameters:

  - solution (`NXOpen.CAE.SimSolution`) –
  - stepType (int) –
  - lbcHierarchyType (`NXOpen.CAE.SimLoadRecipeLbcGeneratorLbcHierarchyTypes`) –

  New in version NX11.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

## GetAllowedStepTypeCount

`SimLoadRecipeLbcGenerator.``GetAllowedStepTypeCount`

  Gets the count of allowable step types when generating steps for a solution from a load recipe.

  Note that not every step type supported by a solution can be created from a load recipe. The value returned by this method is not the same as `NXOpen.CAE.SimSolution.AllowedStepTypeCount()`.

  Signature `GetAllowedStepTypeCount(solution)`

  Parameters: | solution (`NXOpen.CAE.SimSolution`) –
  Returns: | count of allowable step types
  Return type: | int

  New in version NX10.0.0.

  License requirements: None.