FV3 Bundle
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
fv3jedi::IncrementFV3JEDI Class Reference

#include <IncrementFV3JEDI.h>

Inheritance diagram for fv3jedi::IncrementFV3JEDI:
[legend]
Collaboration diagram for fv3jedi::IncrementFV3JEDI:
[legend]

Public Member Functions

 IncrementFV3JEDI (const GeometryFV3JEDI &, const oops::Variables &, const util::DateTime &)
 Constructor, destructor. More...
 
 IncrementFV3JEDI (const GeometryFV3JEDI &, const IncrementFV3JEDI &)
 
 IncrementFV3JEDI (const IncrementFV3JEDI &, const bool)
 
 IncrementFV3JEDI (const IncrementFV3JEDI &)
 
virtual ~IncrementFV3JEDI ()
 
void diff (const StateFV3JEDI &, const StateFV3JEDI &)
 Basic operators. More...
 
void zero ()
 
void zero (const util::DateTime &)
 
IncrementFV3JEDI & operator= (const IncrementFV3JEDI &)
 
IncrementFV3JEDI & operator+= (const IncrementFV3JEDI &)
 
IncrementFV3JEDI & operator-= (const IncrementFV3JEDI &)
 
IncrementFV3JEDI & operator*= (const double &)
 
void axpy (const double &, const IncrementFV3JEDI &, const bool check=true)
 
double dot_product_with (const IncrementFV3JEDI &) const
 
void schur_product_with (const IncrementFV3JEDI &)
 
void random ()
 
void dirac (const eckit::Configuration &)
 
void getValuesTL (const ioda::Locations &, const oops::Variables &, ufo::GeoVaLs &, const GetValuesTrajFV3JEDI &) const
 Get increment values at observation locations. More...
 
void getValuesAD (const ioda::Locations &, const oops::Variables &, const ufo::GeoVaLs &, const GetValuesTrajFV3JEDI &)
 
void ug_coord (oops::UnstructuredGrid &, const int &) const
 Unstructured grid. More...
 
void field_to_ug (oops::UnstructuredGrid &, const int &) const
 
void field_from_ug (const oops::UnstructuredGrid &)
 
void read (const eckit::Configuration &)
 I/O and diagnostics. More...
 
void write (const eckit::Configuration &) const
 
double norm () const
 
void updateTime (const util::Duration &dt)
 
void accumul (const double &, const StateFV3JEDI &)
 Other. More...
 
void jnormgrad (const StateFV3JEDI &, const eckit::Configuration &)
 
boost::shared_ptr< const GeometryFV3JEDI > geometry () const
 
const util::DateTime & time () const
 
util::DateTime & time ()
 
const util::DateTime & validTime () const
 
util::DateTime & validTime ()
 
int & toFortran ()
 
const int & toFortran () const
 
- Public Member Functions inherited from oops::GeneralizedDepartures
 GeneralizedDepartures ()
 
virtual ~GeneralizedDepartures ()
 

Static Public Member Functions

static const std::string classname ()
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

F90inc keyInc_
 
boost::shared_ptr< const GeometryFV3JEDI > geom_
 
oops::Variables vars_
 
util::DateTime time_
 

Detailed Description

Definition at line 55 of file IncrementFV3JEDI.h.

Constructor & Destructor Documentation

◆ IncrementFV3JEDI() [1/4]

fv3jedi::IncrementFV3JEDI::IncrementFV3JEDI ( const GeometryFV3JEDI &  geom,
const oops::Variables &  vars,
const util::DateTime &  time 
)

Constructor, destructor.

Definition at line 35 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ IncrementFV3JEDI() [2/4]

fv3jedi::IncrementFV3JEDI::IncrementFV3JEDI ( const GeometryFV3JEDI &  geom,
const IncrementFV3JEDI &  other 
)

Definition at line 46 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ IncrementFV3JEDI() [3/4]

fv3jedi::IncrementFV3JEDI::IncrementFV3JEDI ( const IncrementFV3JEDI &  other,
const bool  copy 
)

Definition at line 56 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ IncrementFV3JEDI() [4/4]

fv3jedi::IncrementFV3JEDI::IncrementFV3JEDI ( const IncrementFV3JEDI &  other)

Definition at line 70 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ ~IncrementFV3JEDI()

fv3jedi::IncrementFV3JEDI::~IncrementFV3JEDI ( )
virtual

Definition at line 79 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

Member Function Documentation

◆ accumul()

void fv3jedi::IncrementFV3JEDI::accumul ( const double &  zz,
const StateFV3JEDI &  xx 
)

Other.

Definition at line 130 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ axpy()

void fv3jedi::IncrementFV3JEDI::axpy ( const double &  zz,
const IncrementFV3JEDI &  dx,
const bool  check = true 
)

Definition at line 124 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ classname()

static const std::string fv3jedi::IncrementFV3JEDI::classname ( )
inlinestatic

Definition at line 59 of file IncrementFV3JEDI.h.

◆ diff()

void fv3jedi::IncrementFV3JEDI::diff ( const StateFV3JEDI &  x1,
const StateFV3JEDI &  x2 
)

Basic operators.

Definition at line 86 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ dirac()

void fv3jedi::IncrementFV3JEDI::dirac ( const eckit::Configuration &  config)

Definition at line 229 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ dot_product_with()

double fv3jedi::IncrementFV3JEDI::dot_product_with ( const IncrementFV3JEDI &  other) const

Definition at line 138 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ field_from_ug()

void fv3jedi::IncrementFV3JEDI::field_from_ug ( const oops::UnstructuredGrid &  ug)

Definition at line 187 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ field_to_ug()

void fv3jedi::IncrementFV3JEDI::field_to_ug ( oops::UnstructuredGrid &  ug,
const int &  colocated 
) const

Definition at line 182 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ geometry()

boost::shared_ptr<const GeometryFV3JEDI> fv3jedi::IncrementFV3JEDI::geometry ( ) const
inline

Definition at line 106 of file IncrementFV3JEDI.h.

◆ getValuesAD()

void fv3jedi::IncrementFV3JEDI::getValuesAD ( const ioda::Locations &  locs,
const oops::Variables &  vars,
const ufo::GeoVaLs &  gom,
const GetValuesTrajFV3JEDI &  traj 
)

Definition at line 164 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ getValuesTL()

void fv3jedi::IncrementFV3JEDI::getValuesTL ( const ioda::Locations &  locs,
const oops::Variables &  vars,
ufo::GeoVaLs &  gom,
const GetValuesTrajFV3JEDI &  traj 
) const

Get increment values at observation locations.

Definition at line 151 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ jnormgrad()

void fv3jedi::IncrementFV3JEDI::jnormgrad ( const StateFV3JEDI &  xxf,
const eckit::Configuration &  config 
)

Definition at line 234 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ norm()

double fv3jedi::IncrementFV3JEDI::norm ( ) const

Definition at line 205 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ operator*=()

IncrementFV3JEDI & fv3jedi::IncrementFV3JEDI::operator*= ( const double &  zz)

Definition at line 110 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ operator+=()

IncrementFV3JEDI & fv3jedi::IncrementFV3JEDI::operator+= ( const IncrementFV3JEDI &  dx)

Definition at line 98 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ operator-=()

IncrementFV3JEDI & fv3jedi::IncrementFV3JEDI::operator-= ( const IncrementFV3JEDI &  dx)

Definition at line 104 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ operator=()

IncrementFV3JEDI & fv3jedi::IncrementFV3JEDI::operator= ( const IncrementFV3JEDI &  rhs)

Definition at line 92 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ print()

void fv3jedi::IncrementFV3JEDI::print ( std::ostream &  os) const
private

Definition at line 211 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ random()

void fv3jedi::IncrementFV3JEDI::random ( )

Definition at line 145 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ read()

void fv3jedi::IncrementFV3JEDI::read ( const eckit::Configuration &  config)

I/O and diagnostics.

Definition at line 193 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ schur_product_with()

void fv3jedi::IncrementFV3JEDI::schur_product_with ( const IncrementFV3JEDI &  dx)

Definition at line 134 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ time() [1/2]

const util::DateTime& fv3jedi::IncrementFV3JEDI::time ( ) const
inline

Definition at line 108 of file IncrementFV3JEDI.h.

◆ time() [2/2]

util::DateTime& fv3jedi::IncrementFV3JEDI::time ( )
inline

Definition at line 109 of file IncrementFV3JEDI.h.

◆ toFortran() [1/2]

int& fv3jedi::IncrementFV3JEDI::toFortran ( )
inline

Definition at line 113 of file IncrementFV3JEDI.h.

Here is the caller graph for this function:

◆ toFortran() [2/2]

const int& fv3jedi::IncrementFV3JEDI::toFortran ( ) const
inline

Definition at line 114 of file IncrementFV3JEDI.h.

◆ ug_coord()

void fv3jedi::IncrementFV3JEDI::ug_coord ( oops::UnstructuredGrid &  ug,
const int &  colocated 
) const

Unstructured grid.

Definition at line 176 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ updateTime()

void fv3jedi::IncrementFV3JEDI::updateTime ( const util::Duration &  dt)
inline

Definition at line 99 of file IncrementFV3JEDI.h.

Here is the caller graph for this function:

◆ validTime() [1/2]

const util::DateTime& fv3jedi::IncrementFV3JEDI::validTime ( ) const
inline

Definition at line 110 of file IncrementFV3JEDI.h.

Here is the caller graph for this function:

◆ validTime() [2/2]

util::DateTime& fv3jedi::IncrementFV3JEDI::validTime ( )
inline

Definition at line 111 of file IncrementFV3JEDI.h.

◆ write()

void fv3jedi::IncrementFV3JEDI::write ( const eckit::Configuration &  config) const

Definition at line 199 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ zero() [1/2]

void fv3jedi::IncrementFV3JEDI::zero ( )

Definition at line 115 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

◆ zero() [2/2]

void fv3jedi::IncrementFV3JEDI::zero ( const util::DateTime &  vt)

Definition at line 119 of file IncrementFV3JEDI.cc.

Here is the call graph for this function:

Member Data Documentation

◆ geom_

boost::shared_ptr<const GeometryFV3JEDI> fv3jedi::IncrementFV3JEDI::geom_
private

Definition at line 120 of file IncrementFV3JEDI.h.

◆ keyInc_

F90inc fv3jedi::IncrementFV3JEDI::keyInc_
private

Definition at line 119 of file IncrementFV3JEDI.h.

◆ time_

util::DateTime fv3jedi::IncrementFV3JEDI::time_
private

Definition at line 122 of file IncrementFV3JEDI.h.

◆ vars_

oops::Variables fv3jedi::IncrementFV3JEDI::vars_
private

Definition at line 121 of file IncrementFV3JEDI.h.

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