SABER
type_fieldset Module Reference

Random numbers generator derived type. More...

Data Types

type  fieldset_type
 

Functions/Subroutines

subroutine fieldset_init (fieldset, mpl, nmga, nl, gmask, variables, lev2d, afunctionspace)
 Initialized fieldset. More...
 
subroutine fieldset_copy_fields (fieldset_out, fieldset_in)
 Copy fieldset. More...
 
subroutine fieldset_pass_fields (fieldset_out, fieldset_in)
 Pass ATLAS fields from a fieldset to another. More...
 
subroutine fieldset_zero_fields (fieldset)
 Set fieldset to zero. More...
 
subroutine fieldset_add_fields (fieldset_out, fieldset_in)
 Add fieldset. More...
 
subroutine fieldset_sub_fields (fieldset_out, fieldset_in)
 Subtract fieldset. More...
 
subroutine fieldset_mult_fields_scalar (fieldset, factor)
 Multiply fieldset with a scalar. More...
 
subroutine fieldset_mult_fields_fieldset (fieldset_out, fieldset_in)
 Multiply fieldset with another fieldset. More...
 
subroutine fieldset_div_fields (fieldset_out, fieldset_in)
 Divide fieldset. More...
 
subroutine fieldset_square_fields (fieldset)
 Square fieldset. More...
 
subroutine fieldset_sqrt_fields (fieldset)
 Take square-root of the fieldset. More...
 
subroutine fieldset_to_array_single (fieldset, mpl, iv, fld)
 Convert fieldset to Fortran array, single field. More...
 
subroutine fieldset_to_array_all (fieldset, mpl, fld)
 Convert fieldset to Fortran array, all fields. More...
 
subroutine fieldset_from_array_single (fieldset, mpl, iv, fld)
 Convert Fortran array to fieldset, single field. More...
 
subroutine fieldset_from_array_all (fieldset, mpl, fld)
 Convert Fortran array to fieldset, all fields. More...
 

Detailed Description

Random numbers generator derived type.

Function/Subroutine Documentation

◆ fieldset_add_fields()

subroutine type_fieldset::fieldset_add_fields ( class(fieldset_type), intent(inout)  fieldset_out,
type(fieldset_type), intent(in)  fieldset_in 
)
private

Add fieldset.

Parameters
[in,out]fieldset_outOutput fieldset
[in]fieldset_inInput fieldset

Definition at line 231 of file type_fieldset.F90.

◆ fieldset_copy_fields()

subroutine type_fieldset::fieldset_copy_fields ( class(fieldset_type), intent(inout)  fieldset_out,
type(fieldset_type), intent(in)  fieldset_in 
)
private

Copy fieldset.

Parameters
[in,out]fieldset_outOutput fieldset
[in]fieldset_inInput fieldset

Definition at line 119 of file type_fieldset.F90.

◆ fieldset_div_fields()

subroutine type_fieldset::fieldset_div_fields ( class(fieldset_type), intent(inout)  fieldset_out,
type(fieldset_type), intent(in)  fieldset_in 
)
private

Divide fieldset.

Parameters
[in,out]fieldset_outOutput fieldset
[in]fieldset_inInput fieldset

Definition at line 420 of file type_fieldset.F90.

◆ fieldset_from_array_all()

subroutine type_fieldset::fieldset_from_array_all ( class(fieldset_type), intent(inout)  fieldset,
type(mpl_type), intent(inout)  mpl,
real(kind_real), dimension(:,:,:), intent(in)  fld 
)
private

Convert Fortran array to fieldset, all fields.

Parameters
[in,out]mplMPI data
[in]fldFortran array

Definition at line 632 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_from_array_single()

subroutine type_fieldset::fieldset_from_array_single ( class(fieldset_type), intent(inout)  fieldset,
type(mpl_type), intent(inout)  mpl,
integer, intent(in)  iv,
real(kind_real), dimension(:,:), intent(in)  fld 
)
private

Convert Fortran array to fieldset, single field.

Parameters
[in,out]mplMPI data
[in]ivVariable index
[in]fldFortran array

Definition at line 600 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_init()

subroutine type_fieldset::fieldset_init ( class(fieldset_type), intent(inout)  fieldset,
type(mpl_type), intent(inout)  mpl,
integer, intent(in)  nmga,
integer, intent(in)  nl,
logical, dimension(nmga,nl), intent(in)  gmask,
character(len=*), dimension(:), intent(in)  variables,
character(len=*), intent(in)  lev2d,
type(atlas_functionspace), intent(in), optional  afunctionspace 
)
private

Initialized fieldset.

Parameters
[in,out]mplMPI data
[in]nmgaNumber of gridpoints
[in]nlNumber of levels
[in]gmaskGeographical mask
[in]variablesVariables names
[in]lev2dLevel for 2D variables
[in]afunctionspaceATLAS function space

Definition at line 54 of file type_fieldset.F90.

◆ fieldset_mult_fields_fieldset()

subroutine type_fieldset::fieldset_mult_fields_fieldset ( class(fieldset_type), intent(inout)  fieldset_out,
type(fieldset_type), intent(in)  fieldset_in 
)
private

Multiply fieldset with another fieldset.

Parameters
[in,out]fieldset_outOutput fieldset
[in]fieldset_inInput fieldset

Definition at line 369 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_mult_fields_scalar()

subroutine type_fieldset::fieldset_mult_fields_scalar ( class(fieldset_type), intent(inout)  fieldset,
real(kind_real), intent(in)  factor 
)
private

Multiply fieldset with a scalar.

Parameters
[in]factorScalar factor

Definition at line 333 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_pass_fields()

subroutine type_fieldset::fieldset_pass_fields ( class(fieldset_type), intent(inout)  fieldset_out,
type(fieldset_type), intent(in)  fieldset_in 
)
private

Pass ATLAS fields from a fieldset to another.

Parameters
[in,out]fieldset_outOutput fieldset
[in]fieldset_inInput fieldset

Definition at line 166 of file type_fieldset.F90.

◆ fieldset_sqrt_fields()

subroutine type_fieldset::fieldset_sqrt_fields ( class(fieldset_type), intent(inout)  fieldset)
private

Take square-root of the fieldset.

Definition at line 506 of file type_fieldset.F90.

◆ fieldset_square_fields()

subroutine type_fieldset::fieldset_square_fields ( class(fieldset_type), intent(inout)  fieldset)
private

Square fieldset.

Definition at line 471 of file type_fieldset.F90.

◆ fieldset_sub_fields()

subroutine type_fieldset::fieldset_sub_fields ( class(fieldset_type), intent(inout)  fieldset_out,
type(fieldset_type), intent(in)  fieldset_in 
)
private

Subtract fieldset.

Parameters
[in,out]fieldset_outOutput fieldset
[in]fieldset_inInput fieldset

Definition at line 282 of file type_fieldset.F90.

◆ fieldset_to_array_all()

subroutine type_fieldset::fieldset_to_array_all ( class(fieldset_type), intent(in)  fieldset,
type(mpl_type), intent(inout)  mpl,
real(kind_real), dimension(:,:,:), intent(out)  fld 
)
private

Convert fieldset to Fortran array, all fields.

Parameters
[in,out]mplMPI data
[out]fldFortran array

Definition at line 573 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_to_array_single()

subroutine type_fieldset::fieldset_to_array_single ( class(fieldset_type), intent(in)  fieldset,
type(mpl_type), intent(inout)  mpl,
integer, intent(in)  iv,
real(kind_real), dimension(:,:), intent(out)  fld 
)
private

Convert fieldset to Fortran array, single field.

Parameters
[in,out]mplMPI data
[in]ivVariable index
[out]fldFortran array

Definition at line 541 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_zero_fields()

subroutine type_fieldset::fieldset_zero_fields ( class(fieldset_type), intent(inout)  fieldset)
private

Set fieldset to zero.

Definition at line 192 of file type_fieldset.F90.