Interface fortran::syscgetregionf
Definition: syscRegionF.fi (line 44)
Provide an interface to get a System Coupling region.
Members
Public functions
Function syscgetregionf
type(syscregionf) function syscgetregionf(regionName)
Create region to be used in a coupled analysis.
Parameters:
- regionName: - Unique name for this region. String length should not exceed
SyscStrLen.
Display name will default to the same as name.
Topology will default to surface.
Returns:
a SyscRegionF type
Parameters:
- regionNameregionName
Return type: type(syscregionf) function
Function syscgetregionf_t
type(syscregionf) function syscgetregionf_t(regionName, topology)
Create region to be used in a coupled analysis.
Parameters:
- regionName: - Unique name for this region. String length should not exceed SyscStrLen.
- topology: - region topology.
Display name will default to the same as name.
Returns:
a SyscRegionF type
Parameters:
- regionNameregionName
- topologytopology
Return type: type(syscregionf) function
Function syscgetregionf_dt
type(syscregionf) function syscgetregionf_dt(regionName, displayName, topology)
Create region to be used in a coupled analysis.
Parameters:
- regionName: - Unique name for this region. String length should not exceed SyscStrLen.
- displayName: - region display name. String length should not exceed SyscStrLen.
- topology: - region topology.
Returns:
a SyscRegionF type
Parameters:
- regionNameregionName
- displayNamedisplayName
- topologytopology
Return type: type(syscregionf) function
Function syscgetregionf_tm
type(syscregionf) function syscgetregionf_tm(regionName, topology, discretization)
Create a region.
Parameters:
- regionName: - Unique name for this region. String length should not exceed SyscStrLen.
- topology: - region topology.
- discretization: - region discretization type.
Returns:
a SyscRegionF type
Parameters:
- regionNameregionName
- topologytopology
- discretizationdiscretization
Return type: type(syscregionf) function