#include <LAMDomainCheck.h>

Inheritance diagram for ufo::LAMDomainCheck:

Collaboration diagram for ufo::LAMDomainCheck:

[legend]

Public Member Functions
	LAMDomainCheck (const eckit::LocalConfiguration &=eckit::LocalConfiguration())

	~LAMDomainCheck ()

void	compute (const ObsFilterData &, ioda::ObsDataVector< float > &) const
	LAMDomainCheck::compute. More...

const ufo::Variables &	requiredVariables () const
	geovals required to compute the function More...

Public Member Functions inherited from ufo::ObsFunctionBase< float >
	ObsFunctionBase (const eckit::LocalConfiguration conf=eckit::LocalConfiguration())

virtual	~ObsFunctionBase ()

Static Public Member Functions
static const std::string	classname ()

Private Attributes
ufo::Variables	invars_

LAMDomainCheckParameters	options_

Additional Inherited Members
Public Types inherited from ufo::ObsFunctionBase< float >
typedef float	Value_
	Type of the values produced by the function. More...

Detailed Description

Definition at line 52 of file LAMDomainCheck.h.

Constructor & Destructor Documentation

◆ LAMDomainCheck()

ufo::LAMDomainCheck::LAMDomainCheck ( const eckit::LocalConfiguration & conf = eckit::LocalConfiguration() )

explicit

Definition at line 22 of file LAMDomainCheck.cc.

◆ ~LAMDomainCheck()

ufo::LAMDomainCheck::~LAMDomainCheck ( )

Definition at line 36 of file LAMDomainCheck.cc.

Member Function Documentation

◆ classname()

static const std::string ufo::LAMDomainCheck::classname ( )

inlinestatic

Definition at line 54 of file LAMDomainCheck.h.

◆ compute()

void ufo::LAMDomainCheck::compute	(	const ObsFilterData &	in,
		ioda::ObsDataVector< float > &	out
	)		const

virtual

LAMDomainCheck::compute.

The LAMDomainCheck is an obsfunction to compute if an observation is located inside a specified limited area model domain. The LAMDomainCheck obsfunction returns a value of 1 if the observation is determined to be located inside the specified domain and a value of 0 if it lies outside.

In the UFO obs functions YAML, first one must define the map_projection. The following values of map_projection are currently supported:

"gnomonic_ed" - the ESG grid used by FV3-LAM

The option 'save: true' will save the computed value to the output IODA file as 'LAMDomainCheck@DerivedValue' (default is false).

The additional parameters to be defined in the options section of the obs function YAML will depend on the choice of map_projection used. For gnomonic_ed:

a - ESG alpha parameter (default 0)
k - ESG kappa parameter (default 0)
plat - ESG center point latitude (degrees; default 0)
plon - ESG center point longitude (degrees; default 0)
pazi - ESG azimuthal angle (radians; default 0)
dx - grid spacing in x (degrees; default 1)
dy - grid spacing in y (degrees, default 1)
npx - number of gridpoints in x (default 2)
npy - number of gridpoints in y (default 2) If using FV3-LAM, the above values are provided in the netCDF grid file attributes, but this option will work for any regional model that utilizes the Extended Schmidt Gnomonic grid developed by R. Jim Purser: https://dtcenter.org/sites/default/files/events/2020/2-purser-james.pdf "The Extended Schmidt Gnomonic grid for regional applications" by R. J. Purser, D. Jovic, G. Ketefian, T. Black, J. Beck, J. Dong, J. Carley. UFS Users' Workshop, July 27–29, 2020.

Implements ufo::ObsFunctionBase< float >.

Definition at line 75 of file LAMDomainCheck.cc.

Here is the call graph for this function:

◆ requiredVariables()

const ufo::Variables & ufo::LAMDomainCheck::requiredVariables ( ) const

virtual

geovals required to compute the function

Implements ufo::ObsFunctionBase< float >.

Definition at line 132 of file LAMDomainCheck.cc.

Member Data Documentation

◆ invars_

ufo::Variables ufo::LAMDomainCheck::invars_

private

Definition at line 63 of file LAMDomainCheck.h.

◆ options_

LAMDomainCheckParameters ufo::LAMDomainCheck::options_

private

Definition at line 64 of file LAMDomainCheck.h.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members