fms_coupler_util module reference¶

Functions/Subroutines¶

`extract_coupler_values()`	Get element and index of a boundary condition.
`set_coupler_values()`	Set element and index of a boundary condition.

Detailed Description¶

Function/Subroutine Documentation¶

subroutine fms_coupler_util/extract_coupler_values(BC_struc, BC_index, BC_element, array_out, ilb, jlb, is, ie, js, je, conversion)¶

Get element and index of a boundary condition.

Parameters:

ilb :: [in] Lower bounds
jlb :: [in] Lower bounds
array_out :: [out] The array being filled with the input values
bc_struc :: [in] The type from which the data is being extracted
bc_index :: [in] The boundary condition number being extracted
bc_element :: [in] The element of the boundary condition being extracted
is :: [in] The i- limits of array_out to be filled
ie :: [in] The i- limits of array_out to be filled
js :: [in] The j- limits of array_out to be filled
je :: [in] The j- limits of array_out to be filled
conversion :: [in] A number that every element is multiplied by

subroutine fms_coupler_util/set_coupler_values(array_in, BC_struc, BC_index, BC_element, ilb, jlb, is, ie, js, je, conversion)¶

Set element and index of a boundary condition.

Parameters:

ilb :: [in] Lower bounds
jlb :: [in] Lower bounds
array_in :: [in] The array containing the values to load into the BC
bc_struc :: [inout] The type into which the data is being loaded
bc_index :: [in] The boundary condition number being set
bc_element :: [in] The element of the boundary condition being set
is :: [in] The i- limits of array_out to be filled
ie :: [in] The i- limits of array_out to be filled
js :: [in] The j- limits of array_out to be filled
je :: [in] The j- limits of array_out to be filled
conversion :: [in] A number that every element is multiplied by