FMUFieldFunction

class FMUFieldFunction(*args)

Define a FieldFunction from a FMU file.

Parameters:

path_fmustr, path to the FMU file.
input_meshopenturns.Mesh, default=None: Time grid of the input variables, has to be included in the start/final time defined in the FMU.
output_meshopenturns.Mesh, default=None: Time grid of the output variables, has to be included in the start/final time defined in the FMU.
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

`__call__`(*args)	Call self as a function.
`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 field values.
`getOutputDimension`()	Get the dimension of the output field values.
`getOutputMesh`()	Get the mesh associated to the output domain.
`isActingPointwise`()	Whether the function acts point-wise.
`setInputMesh`(inputMesh)	Set the mesh associated to the input domain.
`setName`(name)	Accessor to the object's name.
`setOutputMesh`(outputMesh)	Set the mesh associated to the output domain.

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:

fieldFunctionFieldFunction: 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 field values.

Returns:

outputDescriptionDescription: Description of the output field values.

getOutputDimension()

Get the dimension of the output field values.

Returns:

d’int: Dimension $d'$ of the output field values.

getOutputMesh()

Get the mesh associated to the output domain.

Returns:

outputMeshMesh: The output mesh $\cM_{N'}$ .

isActingPointwise()

Whether the function acts point-wise.

Returns:

pointWisebool: Returns true if the function evaluation at each vertex depends only on the vertex or the value at the vertex.

setInputMesh(inputMesh)

Set the mesh associated to the input domain.

Parameters:

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

setName(name)

Accessor to the object’s name.

Parameters:

namestr: The name of the object.

setOutputMesh(outputMesh)

Set the mesh associated to the output domain.

Parameters:

outputMeshMesh: The output mesh $\cM_{N'}$ .

property thisown: The membership flag