Interface fortran::syscaddinputvariablef

Definition: syscSystemCouplingF.fi (line 265)

Provide an interface to add an input variable.

Members

type(syscerrorf) function syscaddinputvariablef(reg, var)

Provide a function to add an input variable to the region.

If this variable has already been added to the region as an input variable, then this call will have no effect.

If a different variable with the same name has already been added to the region as an input variable, then an error will be returned.

If a variable with the same name has already been added to the region as an output variable, then an error will be returned.

If the variable name contains invalid characters, then an error will be returned.

If the region discretization type is point cloud, then the location of the variable added to this region is insignificant.

Parameters:

reg: Region to which the input variable is to be added.
var: Variable whose values are provided by System Coupling and consumed by the participant.

Returns:

a SyscErrorF type for error checking.

Parameters:

Return type: type(syscerrorf) function