FMUFieldToPointFunction#

class FMUFieldToPointFunction(*args)#

Define a FieldToPointFunction from a FMU file.

Parameters:

path_fmustr, path to the FMU file.
meshopenturns.Mesh, default=None: Time grid of the input variables, must overlap the simulation time interval defined by start_time/final_time. By default defined to a regular grid with the start/final time and default step defined the FMU. It does not override the start/final time of the simulation but input values are interpolated on the simulation time grid according to the given mesh.
inputs_fmuSequence of str, default=None: Names of the variable from the fmu to be used as input variables. By default assigns variables with FMI causality INPUT.
outputs_fmuSequence of str, default=None: Names of the variable from the fmu to be used as output variables. By default assigns variables with FMI causality OUTPUT.
initialization_scriptstr, default=None: Path to the initialization script.
kindstr, default=None: Either “ME” (model exchange) or “CS” (co-simulation) Select a kind of FMU if both are available. Note: Contrary to pyfmi, the default here is “CS” (co-simulation). The rationale behind this choice is that co-simulation may be used to impose a solver not available in pyfmi.
start_timefloat, default=None: The FMU simulation start time. The default behavior is to use the default start time defined the FMU.
final_timefloat, default=None: The FMU simulation stop time. The default behavior is to use the default stop time defined the FMU.

Attributes:

thisown: The membership flag

Methods

`getCallsNumber`()	Get the number of calls of the function.
`getClassName`()	Accessor to the object's name.
`getId`()	Accessor to the object's id.
`getImplementation`()	Accessor to the underlying implementation.
`getInputDescription`()	Get the description of the input field values.
`getInputDimension`()	Get the dimension of the input field values.
`getInputMesh`()	Get the mesh associated to the input domain.
`getMarginal`(*args)	Get the marginal(s) at given indice(s).
`getName`()	Accessor to the object's name.
`getOutputDescription`()	Get the description of the output vector.
`getOutputDimension`()	Get the dimension of the output vector.
`setInputDescription`(inputDescription)	Set the description of the input field values.
`setName`(name)	Accessor to the object's name.
`setOutputDescription`(outputDescription)	Set the description of the output vector.

getCallsNumber()#

Get the number of calls of the function.

Returns:

callsNumberint: Counts the number of times the function has been called since its creation.

getClassName()#

Accessor to the object’s name.

Returns:

class_namestr: The object class name (object.__class__.__name__).

getId()#

Accessor to the object’s id.

Returns:

idint: Internal unique identifier.

getImplementation()#

Accessor to the underlying implementation.

Returns:

implImplementation: A copy of the underlying implementation object.

getInputDescription()#

Get the description of the input field values.

Returns:

inputDescriptionDescription: Description of the input field values.

getInputDimension()#

Get the dimension of the input field values.

Returns:

dint: Dimension \(d\) of the input field values.

getInputMesh()#

Get the mesh associated to the input domain.

Returns:

inputMeshMesh: The input mesh \(\cM_{N'}\).

getMarginal(*args)#

Get the marginal(s) at given indice(s).

Parameters:

iint or list of ints, \(0 \leq i < d\): Indice(s) of the marginal(s) to be extracted.

Returns:

functionFieldToPointFunction: The initial function restricted to the concerned marginal(s) at the indice(s) \(i\).

getName()#

Accessor to the object’s name.

Returns:

namestr: The name of the object.

getOutputDescription()#

Get the description of the output vector.

Returns:

outputDescriptionDescription: Description of the output vector.

getOutputDimension()#

Get the dimension of the output vector.

Returns:

d’int: Dimension \(d'\) of the output vector.

setInputDescription( inputDescription, )#

Set the description of the input field values.

Parameters:

inputDescriptionsequence of str: Description of the input field values.

setName(name)#

Accessor to the object’s name.

Parameters:

namestr: The name of the object.

setOutputDescription( outputDescription, )#

Set the description of the output vector.

Parameters:

outputDescriptionsequence of str: Description of the output vector.

property thisown#: The membership flag