Subroutines/functions list. More...

Data Types
type	fieldset_type

Functions/Subroutines
subroutine	fieldset_init_from_functionspace (fieldset, mpl, afunctionspace, gmask, variables, lev2d)
	Initialize fieldset from function space. More...

subroutine	fieldset_init_from_fieldset (fieldset_out, mpl, fieldset_in, gmask, variables, lev2d, copy, pass)
	Initialize fieldset from another fieldset. More...

subroutine	fieldset_set_metadata (fieldset, mpl, gmask, variables, lev2d)
	Set metadata. More...

subroutine	fieldset_print (fieldset, mpl)
	Print active fields norm. More...

subroutine	fieldset_zero_fields (fieldset, mpl)
	Set fieldset to zero. More...

subroutine	fieldset_add_fields (fieldset_out, mpl, fieldset_in)
	Add fieldset. More...

subroutine	fieldset_sub_fields (fieldset_out, mpl, fieldset_in)
	Subtract fieldset. More...

subroutine	fieldset_mult_fields_scalar (fieldset, mpl, factor)
	Multiply fieldset with a scalar. More...

subroutine	fieldset_mult_fields_fieldset (fieldset_out, mpl, fieldset_in)
	Multiply fieldset with another fieldset. More...

subroutine	fieldset_div_fields (fieldset_out, mpl, fieldset_in)
	Divide fieldset. More...

subroutine	fieldset_square_fields (fieldset, mpl)
	Square fieldset. More...

subroutine	fieldset_sqrt_fields (fieldset, mpl)
	Take square-root of the fieldset. More...

subroutine	fieldset_check_single (fieldset, mpl)
	Check single fieldset consistency. More...

subroutine	fieldset_check_pair (fieldset_out, mpl, fieldset_in)
	Check pair of fieldsets consistency. More...

subroutine	fieldset_apply_mask (fieldset, mpl, msvalr)
	Set masked point to missing value. 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

Subroutines/functions list.

Instrumentation functions 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(mpl_type), intent(inout)	mpl,
		type(fieldset_type), intent(in)	fieldset_in
	)

private

Add fieldset.

Parameters

[in,out]	fieldset_out	Output fieldset
[in,out]	mpl	MPI data
[in]	fieldset_in	Input fieldset

Definition at line 464 of file type_fieldset.F90.

◆ fieldset_apply_mask()

subroutine type_fieldset::fieldset_apply_mask	(	class(fieldset_type), intent(inout)	fieldset,
		type(mpl_type), intent(inout)	mpl,
		real(kind_real), intent(in), optional	msvalr
	)

private

Set masked point to missing value.

Parameters

[in,out]	mpl	MPI data
[in]	msvalr	Specific missing value

Definition at line 989 of file type_fieldset.F90.

◆ fieldset_check_pair()

subroutine type_fieldset::fieldset_check_pair	(	class(fieldset_type), intent(in)	fieldset_out,
		type(mpl_type), intent(inout)	mpl,
		class(fieldset_type), intent(in)	fieldset_in
	)

private

Check pair of fieldsets consistency.

Parameters

[in]	fieldset_out	Output fieldset
[in,out]	mpl	MPI data
[in]	fieldset_in	Input fieldset

Definition at line 930 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_check_single()

subroutine type_fieldset::fieldset_check_single	(	class(fieldset_type), intent(in)	fieldset,
		type(mpl_type), intent(inout)	mpl
	)

private

Check single fieldset consistency.

Parameters

[in,out] mpl MPI data

Definition at line 876 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_div_fields()

subroutine type_fieldset::fieldset_div_fields	(	class(fieldset_type), intent(inout)	fieldset_out,
		type(mpl_type), intent(inout)	mpl,
		type(fieldset_type), intent(inout)	fieldset_in
	)

private

Divide fieldset.

Parameters

[in,out]	fieldset_out	Output fieldset
[in,out]	mpl	MPI data
[in,out]	fieldset_in	Input fieldset

Definition at line 700 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]	mpl	MPI data
[in]	fld	Fortran array

Definition at line 1183 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]	mpl	MPI data
[in]	iv	Variable index
[in]	fld	Fortran array

Definition at line 1140 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_init_from_fieldset()

subroutine type_fieldset::fieldset_init_from_fieldset	(	class(fieldset_type), intent(inout)	fieldset_out,
		type(mpl_type), intent(inout)	mpl,
		type(fieldset_type), intent(in)	fieldset_in,
		logical, dimension(:,:), intent(in), optional	gmask,
		character(len=*), dimension(:), intent(in), optional	variables,
		character(len=*), intent(in), optional	lev2d,
		logical, intent(in), optional	copy,
		logical, intent(in), optional	pass
	)

private

Initialize fieldset from another fieldset.

Parameters

[in,out]	fieldset_out	Output fieldset
[in,out]	mpl	MPI data
[in]	fieldset_in	Input fieldset
[in]	gmask	Geographical mask
[in]	variables	Variables names
[in]	lev2d	Level for 2D variables
[in]	copy	Copy fields data
[in]	pass	Pass fields pointers

Definition at line 157 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_init_from_functionspace()

subroutine type_fieldset::fieldset_init_from_functionspace	(	class(fieldset_type), intent(inout)	fieldset,
		type(mpl_type), intent(inout)	mpl,
		type(atlas_functionspace), intent(in)	afunctionspace,
		logical, dimension(:,:), intent(in)	gmask,
		character(len=*), dimension(:), intent(in)	variables,
		character(len=*), intent(in)	lev2d
	)

private

Initialize fieldset from function space.

Parameters

[in,out]	mpl	MPI data
[in]	afunctionspace	Function space
[in]	gmask	Geographical mask
[in]	variables	Variables names
[in]	lev2d	Level for 2D variables

Definition at line 85 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_mult_fields_fieldset()

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

private

Multiply fieldset with another fieldset.

Parameters

[in,out]	fieldset_out	Output fieldset
[in,out]	mpl	MPI data
[in]	fieldset_in	Input fieldset

Definition at line 640 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,
		type(mpl_type), intent(inout)	mpl,
		real(kind_real), intent(in)	factor
	)

private

Multiply fieldset with a scalar.

Parameters

[in,out]	mpl	MPI data
[in]	factor	Scalar factor

Definition at line 584 of file type_fieldset.F90.

Here is the caller graph for this function:

◆ fieldset_print()

subroutine type_fieldset::fieldset_print	(	class(fieldset_type), intent(inout)	fieldset,
		type(mpl_type), intent(inout)	mpl
	)

private

Print active fields norm.

Parameters

[in,out] mpl MPI data

Definition at line 351 of file type_fieldset.F90.

◆ fieldset_set_metadata()

subroutine type_fieldset::fieldset_set_metadata	(	class(fieldset_type), intent(inout)	fieldset,
		type(mpl_type), intent(inout)	mpl,
		logical, dimension(:,:), intent(in)	gmask,
		character(len=*), dimension(:), intent(in)	variables,
		character(len=*), intent(in)	lev2d
	)

private

Set metadata.

Parameters

[in,out]	mpl	MPI data
[in]	gmask	Geographical mask
[in]	variables	Variables names
[in]	lev2d	Level for 2D variables

Definition at line 299 of file type_fieldset.F90.

◆ fieldset_sqrt_fields()

subroutine type_fieldset::fieldset_sqrt_fields	(	class(fieldset_type), intent(inout)	fieldset,
		type(mpl_type), intent(inout)	mpl
	)

private

Take square-root of the fieldset.

Parameters

[in,out] mpl MPI data

Definition at line 818 of file type_fieldset.F90.

◆ fieldset_square_fields()

subroutine type_fieldset::fieldset_square_fields	(	class(fieldset_type), intent(inout)	fieldset,
		type(mpl_type), intent(inout)	mpl
	)

private

Square fieldset.

Parameters

[in,out] mpl MPI data

Definition at line 763 of file type_fieldset.F90.

◆ fieldset_sub_fields()

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

private

Subtract fieldset.

Parameters

[in,out]	fieldset_out	Output fieldset
[in,out]	mpl	MPI data
[in]	fieldset_in	Input fieldset

Definition at line 524 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]	mpl	MPI data
[out]	fld	Fortran array

Definition at line 1102 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]	mpl	MPI data
[in]	iv	Variable index
[out]	fld	Fortran array

Definition at line 1059 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,
		type(mpl_type), intent(inout)	mpl
	)

private

Set fieldset to zero.

Parameters

[in,out] mpl MPI data

Definition at line 409 of file type_fieldset.F90.

Data Types

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation

◆ fieldset_add_fields()

◆ fieldset_apply_mask()

◆ fieldset_check_pair()

◆ fieldset_check_single()

◆ fieldset_div_fields()

◆ fieldset_from_array_all()

◆ fieldset_from_array_single()

◆ fieldset_init_from_fieldset()

◆ fieldset_init_from_functionspace()

◆ fieldset_mult_fields_fieldset()

◆ fieldset_mult_fields_scalar()

◆ fieldset_print()

◆ fieldset_set_metadata()

◆ fieldset_sqrt_fields()

◆ fieldset_square_fields()

◆ fieldset_sub_fields()

◆ fieldset_to_array_all()

◆ fieldset_to_array_single()

◆ fieldset_zero_fields()