FMS 2025.01.02-dev
Flexible Modeling System
Loading...
Searching...
No Matches
diagdomain_t Type Reference

Type to hold the domain info for an axis This type was created to avoid having to send in "Domain", "Domain2", "DomainUG" as arguments into subroutines and instead only 1 class(diagDomain_t) argument can be send. More...

Public Member Functions

procedure get_ntiles (this)
 Get the ntiles in a domain.
 
procedure length (this, cart_axis, domain_position, global_length)
 Get the length of a 2D domain.
 
procedure set (this, domain, domain2, domainu)
 Set the axis domain.
 

Detailed Description

Type to hold the domain info for an axis This type was created to avoid having to send in "Domain", "Domain2", "DomainUG" as arguments into subroutines and instead only 1 class(diagDomain_t) argument can be send.

Definition at line 64 of file fms_diag_axis_object.F90.

Member Function/Subroutine Documentation

◆ get_ntiles()

procedure get_ntiles ( class(diagdomain_t), intent(in)  this)

Get the ntiles in a domain.

Returns
the number of tiles in a domain
Parameters
[in]thisdiag_axis obj

Definition at line 68 of file fms_diag_axis_object.F90.

◆ length()

procedure length ( class(diagdomain_t), intent(in)  this,
character(len=*), intent(in)  cart_axis,
integer, intent(in)  domain_position,
integer, intent(in)  global_length 
)

Get the length of a 2D domain.

Returns
Length of the 2D domain
Parameters
[in]thisdiag_axis obj
[in]cart_axiscart_axis of the axis
[in]domain_positionDomain position (CENTER, NORTH, EAST)
[in]global_lengthglobal_length of the axis
Returns
If domain is 1D or UG, just set it to the global length

Definition at line 67 of file fms_diag_axis_object.F90.

◆ set()

procedure set ( class(diagdomain_t this,
type(domain1d), intent(in), optional  domain,
type(domain2d), intent(in), optional  domain2,
type(domainug), intent(in), optional  domainu 
)

Set the axis domain.

Parameters
thisfms_domain obj
[in]domain1d domain
[in]domain22d domain
[in]domainuUnstructured domain

Definition at line 66 of file fms_diag_axis_object.F90.


The documentation for this type was generated from the following file: