MOM6
|
Defines the horizontal index type (hor_index_type) used for providing index ranges.
The hor_index_type provides the decalarations and loop ranges for almost all data with horizontal extent.
Declarations and loop ranges should always be coded with the symmetric memory model in mind. The non-symmetric memory mode will then also work, albeit with a different (less efficient) communication pattern.
Using the hor_index_type HI:
h(HI%isd:HI%ied,HI%jsd:HI%jed)
q(HI%IsdB:HI%IedB,HI%JsdB:HI%JedB)
u(HI%IsdB:HI%IedB,HI%jsd:HI%jed)
v(HI%isd:HI%ied,HI%JsdB:HI%JedB)
.For more detail explanation of horizontal indexing see Horizontal indexing and memory.
Data Types | |
interface | assignment(=) |
Copy the contents of one horizontal index type into another. More... | |
type | hor_index_type |
Container for horizontal index ranges for data, computational and global domains. More... | |
Functions/Subroutines | |
subroutine, public | hor_index_init (Domain, HI, param_file, local_indexing, index_offset) |
Sets various index values in a hor_index_type. More... | |
subroutine | hit_assign (HI1, HI2) |
HIT_assign copies one hor_index_type into another. It is accessed via an assignment (=) operator. More... | |
|
private |
HIT_assign copies one hor_index_type into another. It is accessed via an assignment (=) operator.
[out] | hi1 | Horizontal index type to copy to |
[in] | hi2 | Horizontal index type to copy from |
Definition at line 96 of file MOM_hor_index.F90.
subroutine, public mom_hor_index::hor_index_init | ( | type(mom_domain_type), intent(in) | Domain, |
type(hor_index_type), intent(inout) | HI, | ||
type(param_file_type), intent(in) | param_file, | ||
logical, intent(in), optional | local_indexing, | ||
integer, intent(in), optional | index_offset | ||
) |
Sets various index values in a hor_index_type.
[in] | domain | The MOM domain from which to extract information. |
[in,out] | hi | A horizontal index type to populate with data |
[in] | param_file | Parameter file handle |
[in] | local_indexing | If true, all tracer data domains start at 1 |
[in] | index_offset | A fixed additional offset to all indices |
Definition at line 58 of file MOM_hor_index.F90.
References mom_domains::get_domain_extent().
Referenced by mom_oda_driver_mod::init_oda(), mom::initialize_mom(), and mom_grid::mom_grid_init().