soca_fields_metadata_mod::soca_fields_metadata Type Reference

A collection of soca_field_metadata types representing ALL possible fields (state, increment, other derived) in soca. These are read in from a configuration file. More...

Collaboration diagram for soca_fields_metadata_mod::soca_fields_metadata:

Public Member Functions
procedure	create => soca_fields_metadata_create
	Create the main soca_fields_metadata instance by reading in parameters from a yaml file. More...
procedure	clone => soca_fields_metadata_clone
	Make a copy from \rhs to self. More...
procedure	get => soca_fields_metadata_get
	Get the metadata for the field with the given name. More...

Private Attributes
type(soca_field_metadata), dimension(:), allocatable, private	metadata

Related Functions
(Note that these are not member functions.)
subroutine	soca_fields_metadata_create (self, filename)
	Create the main soca_fields_metadata instance by reading in parameters from a yaml file. More...
subroutine	soca_fields_metadata_clone (self, rhs)
	Make a copy from \rhs to self. More...

Detailed Description

A collection of soca_field_metadata types representing ALL possible fields (state, increment, other derived) in soca. These are read in from a configuration file.

Definition at line 36 of file soca_fields_metadata_mod.F90.

Member Function/Subroutine Documentation

clone()

procedure soca_fields_metadata_mod::soca_fields_metadata::clone

Make a copy from \rhs to self.

See also

soca_fields_metadata_clone

Definition at line 46 of file soca_fields_metadata_mod.F90.

create()

procedure soca_fields_metadata_mod::soca_fields_metadata::create

Create the main soca_fields_metadata instance by reading in parameters from a yaml file.

See also

soca_fields_metadata_create

Definition at line 43 of file soca_fields_metadata_mod.F90.

get()

procedure soca_fields_metadata_mod::soca_fields_metadata::get

Get the metadata for the field with the given name.

See also

soca_fields_metadata_get

Definition at line 49 of file soca_fields_metadata_mod.F90.

Friends And Related Function Documentation

soca_fields_metadata_clone()

subroutine soca_fields_metadata_clone ( class(soca_fields_metadata), intent(inout)  self, class(soca_fields_metadata), intent(in)  rhs  )

related

Make a copy from \rhs to self.

Parameters

[in]

rhs

metadata to clone from

Definition at line 140 of file soca_fields_metadata_mod.F90.

soca_fields_metadata_create()

subroutine soca_fields_metadata_create ( class(soca_fields_metadata), intent(inout)  self, character(len=:), intent(in), allocatable  filename  )

related

Create the main soca_fields_metadata instance by reading in parameters from a yaml file.

See the members of soca_field_metadata for a list of valid options

Exceptions

abor1_ftn

aborts if there are duplicate fields

Parameters

[in]

filename

filename of the yaml configuration

Definition at line 66 of file soca_fields_metadata_mod.F90.

Member Data Documentation

metadata

type(soca_field_metadata), dimension(:), allocatable, private soca_fields_metadata_mod::soca_fields_metadata::metadata

private

Definition at line 38 of file soca_fields_metadata_mod.F90.

---

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

• src/soca/Fields/soca_fields_metadata_mod.F90