Motion Standalone Postprocessor C# library 2026 R1

Class OutputReader

Last update: 09.03.2026

Namespace: VM.Post.API.OutputReader
Assembly: VM.Post.API.OutputReader.dll

Represents the API class for reading result files.

public class OutputReader : IOutputReader

Inheritance

object ← OutputReader

Implements

IOutputReader

Examples

For an example that includes information about interfaces, see this example. To view the examples, refer to the location of the 'Install_Path\Motion\Document\Postprocessor API for Python.zip' file.

# OutputReader.py
import clr, os, sys
from pathlib import Path

# Get the current file's path and set the path for external modules.
current_dir = Path(__file__).resolve().parent
external_modules_path = Path(current_dir, r'../../Modules').resolve()
sys.path.append('{0}'.format(external_modules_path))

# Import necessary modules
from ResultFileReaderAPI import *

# Import result file
outputReader = OutputReader(get_result_file_path())

entities = outputReader.GetEntities(EntityType.Body)

print (f"File Path : {outputReader.Path}")
print (f"Version : {outputReader.Version}")

for entity in entities:
    print (f"Entity Name : {entity.FullName}")

# Close
outputReader.Close()

Remarks

This class provides methods to interact with and retrieve information from result files.

Constructors

OutputReader(string)

Initializes a new instance of the class, used to open the result file.

public OutputReader(string filepath)

Parameters

filepath string

The path of the result file.

Examples

For an example that includes this property, see the OutputReader.

Remarks

This constructor opens the specified result file.

Properties

Path

Gets the file path to the Ansys Motion result file (.dfr).

public string Path { get; }

Property Value

string

Examples

For an example that includes this property, see the OutputReader.

Remarks

This property stores the file path to the Ansys Motion result file (.dfr).

Version

Gets the product version.

public string Version { get; }

Property Value

string

Examples

For an example that includes this property, see the OutputReader.

Remarks

This property stores the version of the product.

Methods

Close()

Closes the result file.

public void Close()

Examples

For an example that includes this property, see the OutputReader.

Remarks

This method closes the result file.

CreateCoordinateSystem(string, string)

Creates a new coordinate system marker with the specified name and optional parent.

public GeneralMarker CreateCoordinateSystem(string newName, string parentFullName = "Ground")

Parameters

newName string

The name of the new coordinate system marker.

parentFullName string

The full name of the parent marker. Defaults to .

Returns

GeneralMarker

A representing the newly created coordinate system marker.

Examples

The following example demonstrates how to use the CreateCoordinateSystem method:

print ("===Creating Marker===")
# Create a Coordinate System
# Name - Set the name of instance.
# ParentInfo - Specifies The path of an parent entity.
ground_csys = outputReader.CreateCoordinateSystem("Ground_CSYS")
print(ground_csys.FullName)

rigid_csys = outputReader.CreateCoordinateSystem("Crank_CSYS", "Crank")
print(rigid_csys.FullName)

rigid_cm_csys = outputReader.CreateCoordinateSystem("Crank_CM_CSYS", "Crank/CM")
print(rigid_cm_csys.FullName)

nodal_node_csys = outputReader.CreateCoordinateSystem("FEBody_01_CSYS", "FEBody_01/Node/754")
print(nodal_node_csys.FullName)

Remarks

This method creates a new coordinate system marker with the given name. If the parent full name is not provided, it defaults to the ground marker name as defined by .

CreateVector(string, string, string)

Creates a vector for a specified target entity and characteristic path.

public IVectorDisplay CreateVector(string newName, string target, string path)

Parameters

newName string

The name of the new vector.

target string

Specifies the name of the vector displayable entity.

path string

Specifies the characteristic on the vector display.

Returns

IVectorDisplay

Returns an instance of the created vector.

Examples

The following example demonstrates how to use the GetVector method:

print ("===CreateVector===")
vector = outputReader.CreateVector("vector", "TJ_01", "Action Force")
print(f"Name : {vector.FullName}")    
print(f"Type : {vector.Type}")
print(f"Characteristic : {vector.Characteristic}")
characteristics = list(vector.Target.Characteristics)
for characteristic in characteristics:
    print(f"Target VectorDisplayType : {characteristic.VectorDisplayType}")
    print(f"Target CharacteristicName : {characteristic.CharacteristicName}")

Remarks

This method creates a new vector. The method returns the instance of the newly created vector.

ExportAcousticRawDataToFile(string, string, BehaviorType, FFTParameters, uint[])

Exports acoustic raw data to a file.

public void ExportAcousticRawDataToFile(string filepath, string fullName, BehaviorType behaviorType, FFTParameters parameters, uint[] nodeIDs)

Parameters

filepath string

Specifies the file path to export.

fullName string

Specifies the name of the entity.

behaviorType BehaviorType

Specifies the type of the target for Displacement, Velocity, or Acceleration. The available options are:

parameters FFTParameters

Specifies the FFT parameters. For a description of the parameters, see in the API Reference.

  • - The window type of FFT.
  • - An array of state IDs from the result file.
  • - The number of data points for FFT.

nodeIDs uint[]

Specifies the ID array of the nodes.

Examples

The following example demonstrates how to use the ExportAcousticRawDataToFile method:

print("===ExportAcousticRawDataToFile===")
parameters = FFTParameters()
parameters.WindowType = FFTWindowType.Rectangular
parameters.Points = 128

for ids in stateids:
    parameters.States.Add(ids)

nodeIDs = [1,2,3]

accoustic_result_path = os.path.join(output_dir, r'AcousticRawDataToFile.txt')
outputReader.ExportAcousticRawDataToFile(accoustic_result_path, target, BehaviorType.Displacement, parameters, nodeIDs)

accoustic_without_nodeids_result_path = os.path.join(output_dir, r'AcousticWithoutNodeIDsRawDataToFile.txt')
outputReader.ExportAcousticRawDataToFile(accoustic_without_nodeids_result_path, target, BehaviorType.Displacement, parameters)

Remarks

This method exports acoustic raw data to a specified file path.

ExportAcousticRawDataToFile(string, string, BehaviorType, FFTParameters)

Exports acoustic raw data to a file.

public void ExportAcousticRawDataToFile(string filepath, string fullName, BehaviorType behaviorType, FFTParameters parameters)

Parameters

filepath string

Specifies the file path to export.

fullName string

Specifies the name of the entity.

behaviorType BehaviorType

Specifies the type of behavior for Displacement, Velocity, or Acceleration. The available options are:

parameters FFTParameters

Specifies the FFT parameters. For a description of the parameters, see in the API Reference.

  • - The window type of FFT.
  • - An array of state IDs from the result file.
  • - The number of data points for FFT.

Examples

The following example demonstrates how to use the ExportAcousticRawDataToFile method:

print("===ExportAcousticRawDataToFile===")
parameters = FFTParameters()
parameters.WindowType = FFTWindowType.Rectangular
parameters.Points = 128

for ids in stateids:
    parameters.States.Add(ids)

nodeIDs = [1,2,3]

accoustic_result_path = os.path.join(output_dir, r'AcousticRawDataToFile.txt')
outputReader.ExportAcousticRawDataToFile(accoustic_result_path, target, BehaviorType.Displacement, parameters, nodeIDs)

accoustic_without_nodeids_result_path = os.path.join(output_dir, r'AcousticWithoutNodeIDsRawDataToFile.txt')
outputReader.ExportAcousticRawDataToFile(accoustic_without_nodeids_result_path, target, BehaviorType.Displacement, parameters)

Remarks

This method exports acoustic raw data to a specified file path.

ExportContourResultToFile(string, FileMode, IList<int>, string, ContourMappingType, string, AnalysisResultType, FileFormatType)

Exports contour results to a file.

public void ExportContourResultToFile(string resultpath, FileMode mode, IList<int> stateids, string fullName, ContourMappingType type, string path, AnalysisResultType analysisResultType = AnalysisResultType.Dynamics, FileFormatType formatType = FileFormatType.BINARY)

Parameters

resultpath string

Specifies the file path to export.

mode FileMode

Specifies how the operating system should open a file. The available options are:

stateids IList<int>

Specifies the list of state IDs to time.

fullName string

Specifies the name of the entities.

type ContourMappingType

Specifies the type of the target for displaying contour. The available options are:

path string

This is a combination of characteristic and component.

analysisResultType AnalysisResultType

Specifies the type of analysis result for displaying contour. The default value is . The available options are:

formatType FileFormatType

Specifies the file format type. The default value is . The available options are:

Examples

The following example demonstrates how to use the ExportContourResultToFile method:

print("===ExportContourResultToFile===")
# resultpath - Specifies the file path to export
# mode - Specifies how the operating system should open a file.
# stateids - Specifies the id list of the states to time.
# fullName - Specifies the names of the entities.
# type - Specifies the type of the target for displaying contour(None, FENode, FEElement, FEElementNode, FEMaterial, BeamGroup, Contact, ChainedSystem, Usersubroutine).
# path - Specifies the path of result to save.
# analysisResultType - Specifies the type of analysis result type for displaying contour.
# formatType - Specifies a file format type.

# State ID Array
stateids = outputReader.GetStateIDArray()
target = "FEBody_01"
path = "Top Stress/X"

# The output path is 'examples/Output'.
output_dir = get_output_directory()
nodal_result_path = os.path.join(output_dir, r'ContourResultToFile.txt')
outputReader.ExportContourResultToFile(nodal_result_path, FileMode.Create, stateids, target, ContourMappingType.FENode, path, analysisResultType = AnalysisResultType.Dynamics, formatType = FileFormatType.BINARY)

Remarks

This method exports contour results to a specified file path.

ExportContourResultToFile(string, FileMode, IList<int>, IList<string>, ContourMappingType, string, AnalysisResultType, FileFormatType)

Exports contour results to a file.

public void ExportContourResultToFile(string resultpath, FileMode mode, IList<int> stateids, IList<string> fullNames, ContourMappingType type, string path, AnalysisResultType analysisResultType = AnalysisResultType.Dynamics, FileFormatType formatType = FileFormatType.BINARY)

Parameters

resultpath string

Specifies the file path to export.

mode FileMode

Specifies how the operating system should open a file. The available options are:

stateids IList<int>

Specifies the list of state IDs to time.

fullNames IList<string>

Specifies the names of the entities.

type ContourMappingType

Specifies the type of the target for displaying contour. The available options are:

path string

This is a combination of characteristic and component.

analysisResultType AnalysisResultType

Specifies the type of analysis result for displaying contour. The default value is . The available options are:

formatType FileFormatType

Specifies the file format type. The default value is . The available options are:

Examples

The following example demonstrates how to use the ExportContourResultToFile method:

print("===ExportContourResultToFile===")
# resultpath - Specifies the file path to export
# mode - Specifies how the operating system should open a file.
# stateids - Specifies the id list of the states to time.
# fullName - Specifies the names of the entities.
# type - Specifies the type of the target for displaying contour(None, FENode, FEElement, FEElementNode, FEMaterial, BeamGroup, Contact, ChainedSystem, Usersubroutine).
# path - Specifies the path of result to save.
# analysisResultType - Specifies the type of analysis result type for displaying contour.
# formatType - Specifies a file format type.

# State ID Array
stateids = outputReader.GetStateIDArray()
target = "FEBody_01"
path = "Top Stress/X"

# The output path is 'examples/Output'.
output_dir = get_output_directory()
nodal_result_path = os.path.join(output_dir, r'ContourResultToFile.txt')
outputReader.ExportContourResultToFile(nodal_result_path, FileMode.Create, stateids, target, ContourMappingType.FENode, path, analysisResultType = AnalysisResultType.Dynamics, formatType = FileFormatType.BINARY)

Remarks

This method exports contour results to a specified file path.

ExportMarkerToFile(string, int[], IResultMarker[])

Exports marker results to a file.

public void ExportMarkerToFile(string filePath, int[] stateids, IResultMarker[] markers)

Parameters

filePath string

Specifies the file path to export.

stateids int[]

Specifies the list of state IDs to time.

markers IResultMarker[]

Specifies the list of the marker entities.

Examples

The following example demonstrates how to use the ExportMarkerToFile method:

print("===ExportMarkerToFile===")
# markers = List[IResultMarker](1)
# markers.Add(ground_csys)

# outputReader.ExportMarkerToFile(r'D:\MarkerToFile.txt', stateids, markers)

Remarks

This method exports marker results to a specified file path.

ExportModalBodyRawDataToFile(string, string, bool, bool)

Exports raw data about the FE modal body to a file.

public void ExportModalBodyRawDataToFile(string filePath, string target, bool includeGeometry, bool includeModeShape)

Parameters

filePath string

Specifies the file path to export.

target string

Specifies the name of the entity.

includeGeometry bool

Specifies whether to include geometry data.

includeModeShape bool

Specifies whether to include mode shape data.

Examples

The following example demonstrates how to use the ExportModalBodyRawDataToFile method:

print("===ExportModalBodyRawDataToFile===")
# State ID Array
stateids = outputReader.GetStateIDArray()

modal_result_path = os.path.join(output_dir, r'ModalBodyRawDataToFile.txt')
outputReader.ExportModalBodyRawDataToFile(modal_result_path, "FEBody_01", True, True)

Remarks

This method exports raw data about the FE modal body to a specified file path, including options to include geometry and mode shape data.

ExportVectorDisplayToFile(string, int[], IEnumerable<object>, bool, bool, bool, AnalysisResultType)

Exports vector results to a file.

public void ExportVectorDisplayToFile(string filepath, int[] stateids, IEnumerable<object> targets, bool isIncludePosition, bool includeVector, bool includeMagnitude, AnalysisResultType analysisResultType)

Parameters

filepath string

Specifies the file path to export.

stateids int[]

Specifies the list of state IDs to time.

targets IEnumerable<object>

Specifies the list of the entities.

isIncludePosition bool

Specifies whether to include position data.

includeVector bool

Specifies whether to include vector data.

includeMagnitude bool

Specifies whether to include magnitude data.

analysisResultType AnalysisResultType

Specifies the type of analysis result.

Examples

The following example demonstrates how to use the ExportVectorDisplayToFile method:

print("===ExportVectorDisplayToFile===")
targets = List[IVectorDisplay]()

# target - Specifies the name of vector displayable entity
# path - Specifies characteristc on vector display
vector = outputReader.CreateVector("vector", target, "Base Force")
targets.Add(vector)

vector_result_path = os.path.join(output_dir, r'VectorDisplayToFile.txt')
outputReader.ExportVectorDisplayToFile(vector_result_path, stateids, targets, True, True, True, AnalysisResultType.Dynamics)

vectors_result_path = os.path.join(output_dir, r'VectorsDisplayToFile.txt')
outputReader.ExportVectorDisplayToFile(vectors_result_path, stateids, target, "Base Force", True, True, True, AnalysisResultType.Dynamics)

Remarks

This method exports vector results to a specified file path.

ExportVectorDisplayToFile(string, int[], string, string, bool, bool, bool, AnalysisResultType)

Exports vector results to a file.

public void ExportVectorDisplayToFile(string filepath, int[] stateids, string target, string characteristic, bool isIncludePosition, bool includeVector, bool includeMagnitude, AnalysisResultType analysisResultType)

Parameters

filepath string

Specifies the file path to export.

stateids int[]

Specifies the list of state IDs to time.

target string

Specifies the list of the entities.

characteristic string

The name of the characteristic.

isIncludePosition bool

Specifies whether to include position data.

includeVector bool

Specifies whether to include vector data.

includeMagnitude bool

Specifies whether to include magnitude data.

analysisResultType AnalysisResultType

Specifies the type of analysis result.

Examples

The following example demonstrates how to use the ExportVectorDisplayToFile method:

print("===ExportVectorDisplayToFile===")
targets = List[IVectorDisplay]()

# target - Specifies the name of vector displayable entity
# path - Specifies characteristc on vector display
vector = outputReader.CreateVector("vector", target, "Base Force")
targets.Add(vector)

vector_result_path = os.path.join(output_dir, r'VectorDisplayToFile.txt')
outputReader.ExportVectorDisplayToFile(vector_result_path, stateids, targets, True, True, True, AnalysisResultType.Dynamics)

vectors_result_path = os.path.join(output_dir, r'VectorsDisplayToFile.txt')
outputReader.ExportVectorDisplayToFile(vectors_result_path, stateids, target, "Base Force", True, True, True, AnalysisResultType.Dynamics)

Remarks

This method exports vector results to a specified file path.

GetAssemblyInfo(AssemblyType)

Retrieves an array of state IDs representing sequential states.

public AssemblyInfo[] GetAssemblyInfo(AssemblyType assemblyType = AssemblyType.All)

Parameters

assemblyType AssemblyType

The available options are:

Returns

AssemblyInfo[]

Examples

The following example demonstrates how to use the CreateCoordinateSystem method:

print ("===Assembly Info===")
assemblyInfo = outputReader.GetAssemblyInfo()
for assembly in assemblyInfo:
    print(assembly.FullName)

GetBodies(BodyType, bool)

Retrieves the types and names of bodies based on the specified type and optional inclusion of dummy bodies.

public IEnumerable<(BodyType, string)> GetBodies(BodyType type, bool includeDuymmy = false)

Parameters

type BodyType

Specifies the type of bodies to retrieve. The available options are:

includeDuymmy bool

Specifies whether to include dummy bodies in the result.

Returns

IEnumerable<(BodyType, string)>

An enumerable collection of tuples where each tuple contains a BodyType and its corresponding name.

Examples

The following example demonstrates how to use the GetBodies method:

print ("===Get Bodies===")
bodies = outputReader.GetBodies(BodyType.RIGID)
bodiesList = list(bodies)
for body in bodiesList:
    print(f"Body Type : {body.Item1}, Body Name : {body.Item2}")

Remarks

This method retrieves information about bodies based on the specified type and includes optional dummy bodies if specified. The returned collection contains tuples where each tuple represents a body type and its associated name.

GetBodiesNodeCount(IList<string>)

Gets the count of nodes for the specified bodies.

public long GetBodiesNodeCount(IList<string> bodyNames)

Parameters

bodyNames IList<string>

Specifies the list of names of the entities.

Returns

long

The count of nodes for the specified bodies.

Examples

The following example demonstrates how to use the GetBodiesNodeCount method:

print("===Bodies Node Count===")
entities = List[str]()
entities.Add(r'FEBody_01')
nodecount = outputReader.GetBodiesNodeCount(entities)
print(nodecount)

Remarks

This method retrieves the count of nodes for the specified bodies.

GetConnectors(string)

Retrieves information about connectors associated with the specified body.

public IList<(ConnectorType, ActionType, string)> GetConnectors(string name)

Parameters

name string

The name of the body to retrieve connector information for.

Returns

IList<(ConnectorType, ActionType, string)>

A list of tuples containing the connector type, action type, and names of connectors such as joint, force, and contact. The available connector type are:

The available action type are:

Examples

The following example demonstrates how to use the GetConnectors method:

print ("===GetConnectors===")
connectors = outputReader.GetConnectors("Crank")
connectorlist = list(connectors)

for connector in connectorlist:
    print (f"ConnectorType : {connector.Item1}")
    print (f"Action Type : {connector.Item2}")
    print (f"Name : {connector.Item3}")

Remarks

This method retrieves and returns information about connectors associated with the body identified by the name parameter. The returned list includes tuples where each tuple consists of the connector type, action type, and names of connectors such as joint, force, and contact.

GetContourResult(IList<int>, string, ContourMappingType, string, Action<int, IList<double[]>>, AnalysisResultType)

Exports contour results to a file.

public void GetContourResult(IList<int> stateids, string fullName, ContourMappingType type, string path, Action<int, IList<double[]>> fncallback, AnalysisResultType analysisType = AnalysisResultType.Dynamics)

Parameters

stateids IList<int>

Specifies the list of state IDs to time.

fullName string

Specifies the name of an entity.

type ContourMappingType

Specifies the type of a target for displaying contour. The available options are:

path string

Specifies the path of the result file to save.

fncallback Action<int, IList<double[]>>

Specifies the callback function for getting contour results by report step.

analysisType AnalysisResultType

Specifies the type of analysis result for displaying contour. The default value is . The available options are:

Examples

The following example demonstrates how to use the GetContourResult method:

#print ("===GetContourResult===")
## resultpath - Specifies the file path to export
## mode - Specifies how the operating system should open a file.
## stateids - Specifies the id list of the states to time.
## fullName - Specifies the names of the entities.
## type - Specifies the type of the target for displaying contour(None, FENode, FEElement, FEElementNode, FEMaterial, BeamGroup, Contact, ChainedSystem, Usersubroutine).
## path - Specifies the path of result to save.
## analysisResultType - Specifies the type of analysis result type for displaying contour.
## formatType - Specifies a file format type.

## State ID Array
stateids = outputReader.GetStateIDArray()
target = "FEBody_01"
path = "Top Stress/X"

#contour_result_path = os.path.join(pathSource, r'ExportContourResultToFile.dfr')

# Call GetContourResult with the delegate
def python_action(stateid, resultGroup):
    print("State ID: {0}".format(stateid))
    for result in resultGroup:
        print(f"Array: {[x for x in result]}")

action = Action[Int32, IList[Array[Double]]](python_action)
outputReader.GetContourResult(stateids, target, ContourMappingType.FENode, path, action, AnalysisResultType.Dynamics)

Remarks

This method exports contour results to a specified file path.

GetContourResult(IList<int>, IList<string>, ContourMappingType, string, Action<int, IList<double[]>>, AnalysisResultType)

Exports contour results to a file.

public void GetContourResult(IList<int> stateids, IList<string> fullNames, ContourMappingType type, string path, Action<int, IList<double[]>> fncallback, AnalysisResultType analysisType = AnalysisResultType.Dynamics)

Parameters

stateids IList<int>

Specifies the list of state IDs to time.

fullNames IList<string>

Specifies the names of entities.

type ContourMappingType

Specifies the type of a target for displaying contour. The available options are:

path string

Specifies the path of the result file to save.

fncallback Action<int, IList<double[]>>

Specifies the callback function for getting contour results by report step.

analysisType AnalysisResultType

Specifies the type of analysis result for displaying contour. The default value is . The available options are:

Examples

The following example demonstrates how to use the GetContourResult method:

#print ("===GetContourResult===")
## resultpath - Specifies the file path to export
## mode - Specifies how the operating system should open a file.
## stateids - Specifies the id list of the states to time.
## fullName - Specifies the names of the entities.
## type - Specifies the type of the target for displaying contour(None, FENode, FEElement, FEElementNode, FEMaterial, BeamGroup, Contact, ChainedSystem, Usersubroutine).
## path - Specifies the path of result to save.
## analysisResultType - Specifies the type of analysis result type for displaying contour.
## formatType - Specifies a file format type.

## State ID Array
stateids = outputReader.GetStateIDArray()
target = "FEBody_01"
path = "Top Stress/X"

#contour_result_path = os.path.join(pathSource, r'ExportContourResultToFile.dfr')

# Call GetContourResult with the delegate
def python_action(stateid, resultGroup):
    print("State ID: {0}".format(stateid))
    for result in resultGroup:
        print(f"Array: {[x for x in result]}")

action = Action[Int32, IList[Array[Double]]](python_action)
outputReader.GetContourResult(stateids, target, ContourMappingType.FENode, path, action, AnalysisResultType.Dynamics)

Remarks

This method exports contour results to a specified file path.

GetCurves(PlotParameters)

Retrieves plot data based on the specified plot parameters.

public IDictionary<string, Point2D[]> GetCurves(PlotParameters parameter)

Parameters

parameter PlotParameters

For a description of parameter, see PlotParameters in the API Reference. The parameters used for plotting the curves, including target entity, data paths, coordinate system, and plot data type.

  • - The target entity for plotting the curves.
  • - Default or Plot Data.
  • - An Paths representing the paths to the data to be read. This is a combination of characteristic and component.
  • - The coordinate system to be used.

Returns

IDictionary<string, Point2D[]>

A dictionary containing plot data where each key represents the name or identifier of the curve, and each value is an array of representing the plot points (x, y). The name of plot, List of X and Y data point of plot

Examples

The following example demonstrates how to use the GetCurves method:

print ("===Plot Info===")
curvepaths = List[str]()

curve_paths = List[str]()
curve_paths.Add(r'Displacement/Magnitude')

# Create a PlotParameters object to specify the parameters for the plot.
# Set the Entity to Plot.
# The Target is the name of the target for which you want to retrieve the curves.
# Set the paths for the curves you want to retrieve.
# This is where you specify the characteristics and components you want to plot.
parameters = PlotParameters()
parameters.Paths = curve_paths
parameters.Target = "Crank"

curves = outputReader.GetCurves(parameters)

for curve in curves:
    print(curve.Key)
    for point in curve.Value:
        print(f"X : {point.X}, Y : {point.Y}")

Remarks

This method retrieves and returns plot data based on the provided plot parameters. It generates x and y coordinates for each curve specified in the parameters.

GetEntities(EntityType)

Retrieves all entities of the specified type.

public IEnumerable<EntityBase> GetEntities(EntityType entityType)

Parameters

entityType EntityType

The type of the entities to be retrieved.

Returns

IEnumerable<EntityBase>

An containing all entities of the specified type.

Examples

For an example that includes this property, see the OutputReader.

Remarks

This method retrieves all entities that match the specified entity type. The available options are:

GetFlexibleBodyReferenceFrame(string, bool)

Gets the reference frame of a flexible body.

public IList<double[]> GetFlexibleBodyReferenceFrame(string target, bool recalculateOrientation = false)

Parameters

target string

The name of the flexible body.

recalculateOrientation bool

Get the orientation from element reference frame instead of FE body reference frame

Returns

IList<double[]>

Postion and orientation array with the number of states.

Examples

The following example demonstrates how to use the GetFlexibleBodyReferenceFrame method:

print("===GetFlexibleBodyReferenceFrame===")

# State ID Array
stateids = outputReader.GetStateIDArray()
target = "FEBody_01"

referenceframes = outputReader.GetFlexibleBodyReferenceFrame(target)
position_base_force = []    
for i in range(len(referenceframes)):
    print("Index :", i)
    print(referenceframes[i][0])
    print(referenceframes[i][1])
    print(referenceframes[i][2])
    print(referenceframes[i][3])
    print(referenceframes[i][4])
    print(referenceframes[i][5])
    print(referenceframes[i][6])
    print(referenceframes[i][7])
    print(referenceframes[i][8])
    print(referenceframes[i][9])
    print(referenceframes[i][10])
    print(referenceframes[i][11])

Remarks

This method retrieves the reference frame of the specified flexible body.

GetFrequenciesInfoArray()

Retrieves information about all instances of frequencies.

public IList<(string path, double time, double[] frequencies)> GetFrequenciesInfoArray()

Returns

IList<(string path, double time, double[] frequencies)>

A list containing tuples where each tuple contains:

  • path: The file path of the frequency instance.
  • time: The available sampling time.
  • frequencies: An array of doubles representing the frequencies for the specified sampling time index.

Examples

The following example demonstrates how to use the GetFrequenciesInfoArray method:

print ("===GetFrequenciesInfoArray===")
frequencies = outputReader.GetFrequenciesInfoArray()
frequencyInfoArray = list(frequencies)
for frequency in frequencyInfoArray:
    print (f"File Path : {frequency.Item1}")
    print(f"Sampling Time : {frequency.Item2}")
    indexes = list(frequency.Item3)
    print("Sampling Index :", *indexes, sep=',')

Remarks

This method retrieves and returns information about all instances of frequencies, including their file paths, available sampling times, and corresponding frequency arrays.

GetGeometryInfo(string)

Gets the geometry information for a specified entity.

public IDataPart GetGeometryInfo(string target)

Parameters

target string

Specifies the name of the entity.

Returns

IDataPart

An instance of containing the geometry information.

Examples

The following example demonstrates how to use the GetGeometryInfo method:

print("===Geometry Info===")
nodal = outputReader.GetGeometryInfo("FEBody_01")
print(nodal.DummyNodes)
print(nodal.ElementCount)
print(nodal.ElementsNodeCount)
print(nodal.NodesCount)
print(nodal.PartIndex)

Remarks

This method retrieves the geometry information for the specified entity.

GetGeometryInfoArray()

Gets an array of geometry information.

public IEnumerable<BodyBase> GetGeometryInfoArray()

Returns

IEnumerable<BodyBase>

An containing the geometry information.

Examples

The following example demonstrates how to use the GetGeometryInfoArray method:

print("===GeometryArray===")
geometries = outputReader.GetGeometryInfoArray()
geometry_list = list(geometries)
for geometry in geometry_list:
    print(geometry.FullName)

Remarks

This method retrieves an array of geometry information for all entities.

GetGeometryNodes(string)

Gets the nodes of a specified geometry.

public double[] GetGeometryNodes(string target)

Parameters

target string

Specifies the path of the entity.

Returns

double[]

An array of doubles representing the nodes of the geometry.

Examples

The following example demonstrates how to use the GetGeometryNodes method:

print("===Geometry Nodes===")
geometries = outputReader.GetGeometryNodes("FEBody_01")
for geometry_value in geometries:
    print(geometry_value)

Remarks

This method retrieves the nodes of the specified geometry entity.

GetMarkerInfo(string)

Gets the marker information including position, orientation, velocity, angular velocity, acceleration, and angular acceleration.

public IList<double[]> GetMarkerInfo(string name)

Parameters

name string

Specifies the name of the marker.

Returns

IList<double[]>

A list of double arrays representing the marker values from the start state to the end state, stored sequentially.

Examples

The following example demonstrates how to use the GetMarkerInfo method:

print ("===Marker Info===")
marker_name = r'Crank/CM'
marker = outputReader.GetMarkerInfo(marker_name)

for marker_values in marker:
    for marker_value in marker_values:
        print(marker_value)

Remarks

This method retrieves detailed information about the specified marker, including its position, orientation, velocity, angular velocity, acceleration, and angular acceleration.

GetMarkerPosition(IList<string>)

Gets the marker positions for the specified list of marker names.

public IDictionary<string, IList<double[]>> GetMarkerPosition(IList<string> names)

Parameters

names IList<string>

Specifies the list of marker names to retrieve positions for.

Returns

IDictionary<string, IList<double[]>>

A dictionary where each key is a marker name and the value is a list of double arrays representing marker positions from the start state to the end state, stored sequentially.

Examples

The following example demonstrates how to use the GetMarkerPosition method:

print ("===Marker Position===")

entities = List[str]()
entities.Add(marker_name)
markers = outputReader.GetMarkerPosition(entities)

marker_position = markers[marker_name]
for marker_values in marker_position:
    for marker_value in marker_values:
        print(marker_value)

Remarks

This method retrieves the positions of markers identified by the provided list of names. Each entry in the dictionary corresponds to a marker name and contains its position values over time.

GetModalModeCount(string)

Retrieves the count of modes for the finite element modal body specified by its name.

public int GetModalModeCount(string target)

Parameters

target string

The name of the entity representing the finite element modal body.

Returns

int

The number of modes available for the specified finite element modal body.

Examples

The following example demonstrates how to use the GetModalModeCount method:

print ("===Get Modal Mode Count===")
modecount = outputReader.GetModalModeCount("FEBody_01")
print (modecount)

Remarks

This method retrieves and returns the count of modes available for the specified finite element modal body, identified by its name passed as the target parameter.

GetNamedSelections()

Gets the named selection information.

public NamedSelection[] GetNamedSelections()

Returns

NamedSelection[]

An array of instances representing the named selections.

Examples

The following example demonstrates how to use the GetNamedSelections method:

print("===Named Selections===")
namedselections = outputReader.GetNamedSelections()
for namedselection in namedselections:
    print(namedselection.FullName)

Remarks

This method retrieves the named selection information for the entities.

GetOuterface(string)

Gets the geometry connectivity of an outer face.

public uint[] GetOuterface(string target)

Parameters

target string

Specifies the name of the entity.

Returns

uint[]

An array of unsigned integers representing the geometry connectivity of the outer face.

Examples

The following example demonstrates how to use the GetOuterface method:

print("===Outerface===")
outerface = outputReader.GetOuterface("FEBody_01")
for outerface_value in outerface:
    print(outerface_value)

Remarks

This method retrieves the geometry connectivity information for the outer face of the specified entity. The connectivity is structured in a triangular patch form, allowing for efficient representation and manipulation of 3D surface geometries. Each set of three consecutive integers in the array represents a triangle in the patch.

GetPreviousBodiesNodeCount(IList<string>, string)

Gets the count of nodes for the specified bodies before a certain entity.

public long GetPreviousBodiesNodeCount(IList<string> bodyNames, string target)

Parameters

bodyNames IList<string>

Specifies the list of names of the bodies.

target string

Specifies the name of the entity.

Returns

long

The count of nodes for the previous bodies.

Examples

The following example demonstrates how to use the GetPreviousBodiesNodeCount method:

print("===Previous Bodies NodeCount===")
targets = List[str]()
targets.Add("FEBody_01")
nodeCount = outputReader.GetPreviousBodiesNodeCount(targets, "FEBody_01")

print(nodeCount)

Remarks

This method retrieves the count of nodes for the specified bodies that are processed before the specified entity.

GetPrimaryAnalysisResultType()

Retrieves the type of the primary analysis result.

public AnalysisResultType GetPrimaryAnalysisResultType()

Returns

AnalysisResultType

The type of the primary analysis result. If no primary analysis result is available, returns . The available analysis are:

Examples

The following example demonstrates how to use the GetPrimaryAnalysisResultType method:

print ("===GetPrimaryAnalysisResultType===")
analysistype = outputReader.GetPrimaryAnalysisResultType()
print (analysistype)

Remarks

This method retrieves and returns the type of the primary analysis result from the source data. If the primary analysis result is not set or available, it returns .

GetReferenceTimeArray()

Retrieves an array of reference times from the result report.

public IList<double> GetReferenceTimeArray()

Returns

IList<double>

A list of doubles representing time values from the start state to the end state sequentially.

Examples

The following example demonstrates how to use the GetReferenceTimeArray method:

print ("===Reference TimeArray===")
referenceTimeArray = outputReader.GetReferenceTimeArray()
for referenceTime in referenceTimeArray:
    print(referenceTime)

Remarks

This method retrieves an array of time values that correspond to sequential states within the result report. The times are stored in a list in sequential order.

GetStateIDArray()

Get id array of state

public IList<int> GetStateIDArray()

Returns

IList<int>

A list of integers representing state IDs from the start state to the end state sequentially.

Examples

The following example demonstrates how to use the GetStateIDArray method:

print ("===Get StateIDArray===")
stateIDs = outputReader.GetStateIDArray()
for ids in stateIDs:
    print(ids)

Remarks

This method retrieves an array of state IDs that correspond to sequential states within the system. The IDs are stored in a list in sequential order.

GetUnits()

Retrieves units of results including type, unit, and factor.

public Dictionary<string, KeyValuePair<string, double>> GetUnits()

Returns

Dictionary<string, KeyValuePair<string, double>>

A dictionary where:

  • The key is the type of the result.
  • The value is a key-value pair where:
    • Key: The unit of the result.
    • Value: The factor associated with the unit.

Examples

The following example demonstrates how to use the GetUnits method:

print ("===GetUnits===")
units = outputReader.GetUnits()
for unit in units:
    print(f"Unit Symbol : {unit.Key}")    
    print(f"Unit : {unit.Value.Key}, Value : {unit.Value.Value}")

Remarks

This method returns units associated with different types of results. The dictionary contains entries where each key represents a type of result, and each value is a key-value pair consisting of the unit and its corresponding factor.

GetUnitsFromModeShapeFile(string)

Retrieves unit information from a dfmf file for a specified target.

public Dictionary<string, KeyValuePair<string, double>> GetUnitsFromModeShapeFile(string target)

Parameters

target string

Specifies the target entity for which unit information is retrieved.

Returns

Dictionary<string, KeyValuePair<string, double>>

A dictionary where:

  • Key: Dimension of the result (e.g., length, time).
  • Value: A key-value pair where:
    • Key: The unit string associated with the dimension.
    • Value: The scale factor for converting the unit.

Examples

The following example demonstrates how to use the GetUnitsFromModeShapeFile method:

print ("===GetUnitsFromModeShapeFile===")
units = outputReader.GetUnitsFromModeShapeFile("FEBody_01")
for unit in units:
    print(f"Unit Symbol : {unit.Key}")    
    print(f"Unit : {unit.Value.Key}, Value : {unit.Value.Value}")

Remarks

This method retrieves unit information from a dfmf file specifically for mode shapes. The dictionary contains entries where each key represents a dimension of the result (e.g., length, time), and each value is a key-value pair consisting of the unit string and its corresponding scale factor.

GetVector(string, string)

Retrieves vector results for a specified target entity and characteristic path.

public IDictionary<string, IVectorDisplayAnimationData> GetVector(string target, string path)

Parameters

target string

Specifies the name of the vector displayable entity.

path string

Specifies the characteristic on the vector display.

Returns

IDictionary<string, IVectorDisplayAnimationData>

A dictionary where:

  • Key: String identifier associated with the vector data.
  • Value: Object implementing interface, containing vector display animation data.

Examples

The following example demonstrates how to use the GetVector method:

print ("===GetVector===")
vectors = outputReader.GetVector("TJ_01", "Action Force")
for vector in vectors:
    print(f"Vector : {vector.Key}")
    animation_data = vector.Value

    positions = len(list(animation_data.Positions))
    for i in range(positions):
        first_positions = len(list(animation_data.Positions[i]))
        for j in range(first_positions):
            second_positions = list(animation_data.Positions[i][j])
            print("Positions :", *second_positions, sep=',')

    vectors = len(list(animation_data.Vectors))
    for i in range(vectors):
        first_vectors = len(list(animation_data.Vectors[i]))
        for j in range(first_vectors):
            second_vectors = list(animation_data.Vectors[i][j])
            print("Vectors :", *second_vectors, sep=',')

Remarks

This method retrieves vector results for a specified entity and characteristic path. The returned dictionary contains entries where each key represents a string identifier associated with the vector data, and each value is an object that implements the interface, containing animation data specific to the vector display.

GetVector(string, string, AnalysisResultType)

Retrieves vector results for a specified target entity, characteristic path, and analysis result type.

public IDictionary<string, IVectorDisplayAnimationData> GetVector(string target, string path, AnalysisResultType analysisResultType = AnalysisResultType.Dynamics)

Parameters

target string

Specifies the name of the vector displayable entity.

path string

Specifies the characteristic on the vector display.

analysisResultType AnalysisResultType

Specifies the type of analysis result for the vector display. The available options are:

Returns

IDictionary<string, IVectorDisplayAnimationData>

A dictionary where:

  • Key: String identifier associated with the vector data.
  • Value: Object implementing interface, containing vector display animation data.

Examples

The following example demonstrates how to use the GetVector method:

print ("===GetVector===")
vectors = outputReader.GetVector("TJ_01", "Action Force")
for vector in vectors:
    print(f"Vector : {vector.Key}")
    animation_data = vector.Value

    positions = len(list(animation_data.Positions))
    for i in range(positions):
        first_positions = len(list(animation_data.Positions[i]))
        for j in range(first_positions):
            second_positions = list(animation_data.Positions[i][j])
            print("Positions :", *second_positions, sep=',')

    vectors = len(list(animation_data.Vectors))
    for i in range(vectors):
        first_vectors = len(list(animation_data.Vectors[i]))
        for j in range(first_vectors):
            second_vectors = list(animation_data.Vectors[i][j])
            print("Vectors :", *second_vectors, sep=',')

Remarks

This method retrieves vector results for a specified entity, characteristic path, and analysis result type. The returned dictionary contains entries where each key represents a string identifier associated with the vector data, and each value is an object that implements the interface, containing animation data specific to the vector display.

InterpolationAkimaSpline(double[], double[], int, int, double, double)

Interpolates data series using the Akima spline method.

public (InterpolationErrorType, double[], double[]) InterpolationAkimaSpline(double[] X, double[] Y, int NoOfPnt, int NoOfDesiredPnt, double StartPnt, double EndPnt)

Parameters

X double[]

The array of x-values representing plot data.

Y double[]

The array of y-values representing plot data.

NoOfPnt int

The number of points in the original data series.

NoOfDesiredPnt int

The number of points desired in the interpolated data series.

StartPnt double

The start point for using the curve on the plot data.

EndPnt double

The end point for using the curve on the plot data.

Returns

(InterpolationErrorType, double[], double[])

A tuple containing:

  • An indicating the interpolation error type.
  • - The target entity for plotting the curves.
  • - Default or Plot Data.
- An array of x-values representing the interpolated data points. - An array of y-values representing the interpolated data points.

Examples

The following example demonstrates how to use the InterpolationAkimaSpline method:

print ("===Interpolation===")
x = [1,2,3,4,5]
y = [1,2,3,4,5]
plot = outputReader.InterpolationAkimaSpline(x, y, 5, 100, 0.0, 10.0);
count = len(list(plot.Item2))
print(f"InterpolationErrorType : {plot.Item1}")

for index in range(count):
    print(f"X : {plot.Item2[index]}, Y : {plot.Item3[index]}")

Remarks

This method interpolates the given data series using the Akima spline interpolation method. It returns the interpolated x and y data points based on the specified parameters.

Connect with Ansys