SOCA
soca_fields_mod Module Reference

Handle fields for the model. More...

Data Types

type  soca_field
 Holds all data and metadata related to a single field variable. More...
 
type  soca_fields
 A collection of soca_field types representing a collective state or increment. More...
 

Functions/Subroutines

subroutine fldinfo (fld, mask, info)
 Calculate min/max/mean statistics for a given field, using a mask. More...
 
character(len=length) function soca_genfilename (f_conf, length, vdate, domain_type)
 Generate filename (based on oops/qg) More...
 

Detailed Description

Handle fields for the model.

soca_fields represents a state or increment, and contains one or more soca_field instances for each of the fields. The metadata associated with a given field is stored in soca_fields_metadata_mod::soca_fields_metadata

Function/Subroutine Documentation

◆ fldinfo()

subroutine soca_fields_mod::fldinfo ( real(kind=kind_real), dimension(:,:,:), intent(in)  fld,
logical, dimension(:,:), intent(in)  mask,
real(kind=kind_real), dimension(3), intent(out)  info 
)
private

Calculate min/max/mean statistics for a given field, using a mask.

Parameters
[in]fld: the field to calculate the statistics on
[in]mask: statistics are only calculated where mask is .true.
[out]info: [0] = min, [1] = max, [2] = average

Definition at line 1331 of file soca_fields_mod.F90.

Here is the caller graph for this function:

◆ soca_genfilename()

character(len=length) function soca_fields_mod::soca_genfilename ( type(fckit_configuration), intent(in)  f_conf,
integer, intent(in)  length,
type(datetime), intent(in)  vdate,
character(len=3), intent(in), optional  domain_type 
)
private

Generate filename (based on oops/qg)

The configuration f_conf is expected to provide the following

  • "datadir" : the directory the filenames should be prefixed with
  • "exp" : experiment name
  • "type" : one of "fc", "an", "incr", "ens"
  • "member" : required only if "type == ens"

Definition at line 1361 of file soca_fields_mod.F90.

Here is the caller graph for this function: