syscgetregionf Interface Reference
Last update: 17.07.2025Provide an interface to get a System Coupling region. More...
Public Member Functions | |
| type(syscregionf) function | syscgetregionf (regionName) |
| Create region to be used in a coupled analysis. More... | |
| type(syscregionf) function | syscgetregionf_t (regionName, topology) |
| Create region to be used in a coupled analysis. More... | |
| type(syscregionf) function | syscgetregionf_dt (regionName, displayName, topology) |
| Create region to be used in a coupled analysis. More... | |
| type(syscregionf) function | syscgetregionf_tm (regionName, topology, discretization) |
| Create a region. More... | |
Detailed Description
Provide an interface to get a System Coupling region.
Definition at line 44 of file syscRegionF.fi.
Constructor & Destructor Documentation
◆ syscgetregionf()
| type(syscregionf) function syscgetregionf | ( | character(len=*), intent(in) | regionName | ) |
Create region to be used in a coupled analysis.
- Parameters
-
[in] 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
SyscRegionFtype
Definition at line 58 of file syscRegionF.fi.
Member Function/Subroutine Documentation
◆ syscgetregionf_dt()
| type(syscregionf) function syscgetregionf_dt | ( | character(len=*), intent(in) | regionName, |
| character(len=*), intent(in) | displayName, | ||
| integer(kind=4), intent(in) | topology | ||
| ) |
Create region to be used in a coupled analysis.
- Parameters
-
[in] regionName - Unique name for this region. String length should not exceed SyscStrLen. [in] displayName - region display name. String length should not exceed SyscStrLen. [in] topology - region topology.
- Returns
- a
SyscRegionFtype
Definition at line 108 of file syscRegionF.fi.
◆ syscgetregionf_t()
| type(syscregionf) function syscgetregionf_t | ( | character(len=*), intent(in) | regionName, |
| integer(kind=4), intent(in) | topology | ||
| ) |
Create region to be used in a coupled analysis.
- Parameters
-
[in] regionName - Unique name for this region. String length should not exceed SyscStrLen. [in] topology - region topology.
Display name will default to the same as name.
- Returns
- a
SyscRegionFtype
Definition at line 82 of file syscRegionF.fi.
◆ syscgetregionf_tm()
| type(syscregionf) function syscgetregionf_tm | ( | character(len=*), intent(in) | regionName, |
| integer(kind=4), intent(in) | topology, | ||
| integer(kind=4), intent(in) | discretization | ||
| ) |
Create a region.
- Parameters
-
[in] regionName - Unique name for this region. String length should not exceed SyscStrLen. [in] topology - region topology. [in] discretization - region discretization type.
- Returns
- a
SyscRegionFtype
Definition at line 135 of file syscRegionF.fi.