OOPS
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
oops::WeightedDiffTLAD< MODEL > Class Template Reference

Compute time average of states or increments during linear model run. More...

#include <WeightedDiffTLAD.h>

Inheritance diagram for oops::WeightedDiffTLAD< MODEL >:
Inheritance graph
[legend]
Collaboration diagram for oops::WeightedDiffTLAD< MODEL >:
Collaboration graph
[legend]

Public Member Functions

 WeightedDiffTLAD (const Variables &, const util::DateTime &, const util::Duration &, const util::Duration &, const Geometry_ &, WeightingFct &)
 
virtual ~WeightedDiffTLAD ()
 
Increment_ * releaseDiff ()
 
void setupTL (const Geometry_ &)
 
void finalTL (Increment_ &)
 
void setupAD (std::shared_ptr< const Increment_ >)
 
- Public Member Functions inherited from oops::PostBaseTLAD< MODEL >
 PostBaseTLAD ()
 
 PostBaseTLAD (const util::DateTime &start, const util::DateTime &finish, const util::Duration &freq=util::Duration(0))
 
virtual ~PostBaseTLAD ()
 
void initializeTraj (const State_ &xx, const util::DateTime &end, const util::Duration &step)
 Set linearization state. More...
 
void processTraj (const State_ &xx)
 
void finalizeTraj (const State_ &xx)
 
void initializeTL (const Increment_ &dx, const util::DateTime &end, const util::Duration &step)
 Tangent linear methods. More...
 
void processTL (const Increment_ &dx)
 
void finalizeTL (const Increment_ &dx)
 
void initializeAD (Increment_ &dx, const util::DateTime &bgn, const util::Duration &step)
 Adjoint methods. More...
 
void processAD (Increment_ &dx)
 
void finalizeAD (Increment_ &dx)
 

Private Types

typedef Geometry< MODEL > Geometry_
 
typedef Increment< MODEL > Increment_
 
typedef State< MODEL > State_
 

Private Member Functions

void doInitializeTraj (const State_ &, const util::DateTime &, const util::Duration &) override
 
void doProcessingTraj (const State_ &) override
 
void doFinalizeTraj (const State_ &) override
 
void doInitializeTL (const Increment_ &, const util::DateTime &, const util::Duration &) override
 
void doProcessingTL (const Increment_ &) override
 
void doFinalizeTL (const Increment_ &) override
 
void doFirstAD (Increment_ &, const util::DateTime &, const util::Duration &) override
 
void doProcessingAD (Increment_ &) override
 
void doLastAD (Increment_ &) override
 

Private Attributes

Variables vars_
 
WeightingFct & wfct_
 
WeightedDiff< MODEL, Increment_, State_ > wdiff_
 
std::map< util::DateTime, double > weights_
 
std::shared_ptr< const Increment_ > forcing_
 
std::unique_ptr< Accumulator< MODEL, Increment_, Increment_ > > avg_
 
double sum_
 
bool linit_
 
const util::DateTime vtime_
 
const util::DateTime bgn_
 
const util::DateTime end_
 
util::Duration tstep_
 
util::DateTime bgnleg_
 
util::DateTime endleg_
 

Detailed Description

template<typename MODEL>
class oops::WeightedDiffTLAD< MODEL >

Compute time average of states or increments during linear model run.

Derived classes will compute different types of averages (plain mean, various types of digital filters) by overwriting the weights computation method.

A lot of code here is common with WeightedDiff and even WeightedMean, the design could be improved to reduce code duplication. YT

Definition at line 46 of file WeightedDiffTLAD.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL >
typedef Geometry<MODEL> oops::WeightedDiffTLAD< MODEL >::Geometry_
private

Definition at line 47 of file WeightedDiffTLAD.h.

◆ Increment_

template<typename MODEL >
typedef Increment<MODEL> oops::WeightedDiffTLAD< MODEL >::Increment_
private

Definition at line 48 of file WeightedDiffTLAD.h.

◆ State_

template<typename MODEL >
typedef State<MODEL> oops::WeightedDiffTLAD< MODEL >::State_
private

Definition at line 49 of file WeightedDiffTLAD.h.

Constructor & Destructor Documentation

◆ WeightedDiffTLAD()

template<typename MODEL >
oops::WeightedDiffTLAD< MODEL >::WeightedDiffTLAD ( const Variables &  vars,
const util::DateTime &  vt,
const util::Duration &  span,
const util::Duration &  tstep,
const Geometry_ &  resol,
WeightingFct &  wfct 
)

Definition at line 95 of file WeightedDiffTLAD.h.

◆ ~WeightedDiffTLAD()

template<typename MODEL >
virtual oops::WeightedDiffTLAD< MODEL >::~WeightedDiffTLAD ( )
inlinevirtual

Definition at line 54 of file WeightedDiffTLAD.h.

Member Function Documentation

◆ doFinalizeTL()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::doFinalizeTL ( const Increment_ &  )
inlineoverrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 70 of file WeightedDiffTLAD.h.

◆ doFinalizeTraj()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::doFinalizeTraj ( const State_ &  xx)
overrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 132 of file WeightedDiffTLAD.h.

◆ doFirstAD()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::doFirstAD ( Increment_ &  dx,
const util::DateTime &  bgn,
const util::Duration &  tstep 
)
overrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 209 of file WeightedDiffTLAD.h.

Here is the call graph for this function:

◆ doInitializeTL()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::doInitializeTL ( const Increment_ &  dx,
const util::DateTime &  end,
const util::Duration &  tstep 
)
overrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 150 of file WeightedDiffTLAD.h.

Here is the call graph for this function:

◆ doInitializeTraj()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::doInitializeTraj ( const State_ &  xx,
const util::DateTime &  end,
const util::Duration &  tstep 
)
overrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 113 of file WeightedDiffTLAD.h.

◆ doLastAD()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::doLastAD ( Increment_ &  )
inlineoverrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 74 of file WeightedDiffTLAD.h.

◆ doProcessingAD()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::doProcessingAD ( Increment_ &  dx)
overrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 231 of file WeightedDiffTLAD.h.

Here is the call graph for this function:

◆ doProcessingTL()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::doProcessingTL ( const Increment_ &  xx)
overrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 172 of file WeightedDiffTLAD.h.

Here is the call graph for this function:

◆ doProcessingTraj()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::doProcessingTraj ( const State_ &  xx)
overrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 123 of file WeightedDiffTLAD.h.

◆ finalTL()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::finalTL ( Increment_ &  out)

Definition at line 188 of file WeightedDiffTLAD.h.

◆ releaseDiff()

template<typename MODEL >
Increment_* oops::WeightedDiffTLAD< MODEL >::releaseDiff ( )
inline

Definition at line 56 of file WeightedDiffTLAD.h.

◆ setupAD()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::setupAD ( std::shared_ptr< const Increment_ >  forcing)

Definition at line 199 of file WeightedDiffTLAD.h.

◆ setupTL()

template<typename MODEL >
void oops::WeightedDiffTLAD< MODEL >::setupTL ( const Geometry_ &  resol)

Definition at line 141 of file WeightedDiffTLAD.h.

Member Data Documentation

◆ avg_

template<typename MODEL >
std::unique_ptr<Accumulator<MODEL, Increment_, Increment_> > oops::WeightedDiffTLAD< MODEL >::avg_
private

Definition at line 81 of file WeightedDiffTLAD.h.

◆ bgn_

template<typename MODEL >
const util::DateTime oops::WeightedDiffTLAD< MODEL >::bgn_
private

Definition at line 85 of file WeightedDiffTLAD.h.

◆ bgnleg_

template<typename MODEL >
util::DateTime oops::WeightedDiffTLAD< MODEL >::bgnleg_
private

Definition at line 88 of file WeightedDiffTLAD.h.

◆ end_

template<typename MODEL >
const util::DateTime oops::WeightedDiffTLAD< MODEL >::end_
private

Definition at line 86 of file WeightedDiffTLAD.h.

◆ endleg_

template<typename MODEL >
util::DateTime oops::WeightedDiffTLAD< MODEL >::endleg_
private

Definition at line 89 of file WeightedDiffTLAD.h.

◆ forcing_

template<typename MODEL >
std::shared_ptr<const Increment_> oops::WeightedDiffTLAD< MODEL >::forcing_
private

Definition at line 80 of file WeightedDiffTLAD.h.

◆ linit_

template<typename MODEL >
bool oops::WeightedDiffTLAD< MODEL >::linit_
private

Definition at line 83 of file WeightedDiffTLAD.h.

◆ sum_

template<typename MODEL >
double oops::WeightedDiffTLAD< MODEL >::sum_
private

Definition at line 82 of file WeightedDiffTLAD.h.

◆ tstep_

template<typename MODEL >
util::Duration oops::WeightedDiffTLAD< MODEL >::tstep_
private

Definition at line 87 of file WeightedDiffTLAD.h.

◆ vars_

template<typename MODEL >
Variables oops::WeightedDiffTLAD< MODEL >::vars_
private

Definition at line 76 of file WeightedDiffTLAD.h.

◆ vtime_

template<typename MODEL >
const util::DateTime oops::WeightedDiffTLAD< MODEL >::vtime_
private

Definition at line 84 of file WeightedDiffTLAD.h.

◆ wdiff_

template<typename MODEL >
WeightedDiff<MODEL, Increment_, State_> oops::WeightedDiffTLAD< MODEL >::wdiff_
private

Definition at line 78 of file WeightedDiffTLAD.h.

◆ weights_

template<typename MODEL >
std::map< util::DateTime, double > oops::WeightedDiffTLAD< MODEL >::weights_
private

Definition at line 79 of file WeightedDiffTLAD.h.

◆ wfct_

template<typename MODEL >
WeightingFct& oops::WeightedDiffTLAD< MODEL >::wfct_
private

Definition at line 77 of file WeightedDiffTLAD.h.

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