syscaddinputvariablef Interface Reference
Last update: 17.07.2025Provide an interface to add an input variable. More...
Public Member Functions | |
| type(syscerrorf) function | syscaddinputvariablef (reg, var) |
| Provide a function to add an input variable to the region. More... | |
Detailed Description
Provide an interface to add an input variable.
Definition at line 265 of file syscSystemCouplingF.fi.
Constructor & Destructor Documentation
◆ syscaddinputvariablef()
| type(syscerrorf) function syscaddinputvariablef | ( | type(syscregionf), intent(in) | reg, |
| type(syscvariablef), intent(in) | 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
-
[in] reg Region to which the input variable is to be added. [in] var Variable whose values are provided by System Coupling and consumed by the participant.
- Returns
- a
SyscErrorFtype for error checking.
Definition at line 290 of file syscSystemCouplingF.fi.
