Class SimulationAPI

Namespace: VM.API.Pre
Assembly: VM.API.Pre.dll

This class implements APIs for simulation.

public static class SimulationAPI

Inheritance

object ← SimulationAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)

Methods

ExportDFG(DocumentAnalysis, string)

Export DFG file

[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFG(this DocumentAnalysis document, string targetPath)

Parameters

document DocumentAnalysis

The for exporting DFG file. If null, the active document will be used.

targetPath string

The file path to export DFG file exclude file extension.

ExportDFS(DocumentAnalysis, string)

Export DFS file

[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFS(this DocumentAnalysis document, string targetPath)

Parameters

document DocumentAnalysis

The for exporting DFS file. If null, the active document will be used.

targetPath string

The file path to export DFS file exclude file extension.

ExportDFSXML(DocumentAnalysis, string)

Export DFSXML file

[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportDFSXML(this DocumentAnalysis document, string targetPath)

Parameters

document DocumentAnalysis

The for exporting DFSXML file. If null, the active document will be used.

targetPath string

The file path to export DFSXML file exclude file extension.

ExportMotionFiles(DocumentAnalysis, string, bool, bool, bool, bool)

Export motion files.

[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "targetPath" })]
public static void ExportMotionFiles(this DocumentAnalysis document, string targetPath, bool writeDFS, bool writeXML, bool writeDFG, bool includeReferenceFiles)

Parameters

document DocumentAnalysis

The for exporting motion files. If null, the active document will be used.

targetPath string

The file path to export motion files exclude file extension.

writeDFS bool

The flag for whether to write on dfs or not.

writeXML bool

The flag for whether to write on dfsxml or not.

writeDFG bool

The flag for whether to write on dfg or not.

includeReferenceFiles bool

The flag for whether to include reference files or not.

RunSimulation(DocumentAnalysis, SimulationParameter)

Run simulation.

[NotNull(new string[] { "document" })]
public static void RunSimulation(this DocumentAnalysis document, SimulationRun.SimulationParameter simulationParameter = null)

Parameters

document DocumentAnalysis

The for simulate. If null, the active document will be used.

simulationParameter SimulationRun.SimulationParameter

The simulation parameter.

SetAutoPostRunner(SubSystemDocument, bool)

Sets the solver commands.

public static void SetAutoPostRunner(this SubSystemDocument subSystemDocument, bool autoPostRunner)

Parameters

subSystemDocument SubSystemDocument

The document to set the solver commands.

autoPostRunner bool

The flag of auto post runner.

SetDynamicNumericalDamping(SubSystemDocument, double)

Sets the dynamic numerical damping.

public static void SetDynamicNumericalDamping(this SubSystemDocument subSystemDocument, double numericalDamping)

Parameters

subSystemDocument SubSystemDocument

The document to set the dynamic numerical damping.

numericalDamping double

The value of numerical damping.

SetSolverCommands(SubSystemDocument, string)

Sets the solver commands.

public static void SetSolverCommands(this SubSystemDocument subSystemDocument, string commands)

Parameters

subSystemDocument SubSystemDocument

The document to set the solver commands.

commands string

The value of solver commands.

SetStaticNumericalDamping(SubSystemDocument, double)

Sets the static numerical damping.

public static void SetStaticNumericalDamping(this SubSystemDocument subSystemDocument, double numericalDamping)

Parameters

subSystemDocument SubSystemDocument

The document to set the static numerical damping.

numericalDamping double

The value of numerical damping.

SetThermalNumericalDamping(SubSystemDocument, double)

Sets the thermal numerical damping.

public static void SetThermalNumericalDamping(this SubSystemDocument subSystemDocument, double numericalDamping)

Parameters

subSystemDocument SubSystemDocument

The document to set the thermal numerical damping.

numericalDamping double

The value of numerical damping.