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

#include <JqTermTLAD.h>

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

Public Member Functions

 JqTermTLAD (const eckit::mpi::Comm &)
 
 ~JqTermTLAD ()
 
void clear ()
 
State_ & getMxi () const
 
void computeModelErrorTL (Increment_ &)
 
void setupAD (const Increment_ &dx)
 
- 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 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

const eckit::mpi::Comm & commTime_
 
std::unique_ptr< State_ > xtraj_
 
std::unique_ptr< Increment_ > mxi_
 
std::unique_ptr< Increment_ > xi_
 

Detailed Description

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

Definition at line 29 of file JqTermTLAD.h.

Member Typedef Documentation

◆ Increment_

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

Definition at line 30 of file JqTermTLAD.h.

◆ State_

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

Definition at line 31 of file JqTermTLAD.h.

Constructor & Destructor Documentation

◆ JqTermTLAD()

template<typename MODEL >
oops::JqTermTLAD< MODEL >::JqTermTLAD ( const eckit::mpi::Comm &  comm)
explicit

Definition at line 68 of file JqTermTLAD.h.

◆ ~JqTermTLAD()

template<typename MODEL >
oops::JqTermTLAD< MODEL >::~JqTermTLAD ( )
inline

Definition at line 35 of file JqTermTLAD.h.

Member Function Documentation

◆ clear()

template<typename MODEL >
void oops::JqTermTLAD< MODEL >::clear ( )
inline

Definition at line 37 of file JqTermTLAD.h.

◆ computeModelErrorTL()

template<typename MODEL >
void oops::JqTermTLAD< MODEL >::computeModelErrorTL ( Increment_ &  dx)

Definition at line 142 of file JqTermTLAD.h.

Here is the call graph for this function:

◆ doFinalizeTL()

template<typename MODEL >
void oops::JqTermTLAD< MODEL >::doFinalizeTL ( const Increment_ &  dx)
overrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 130 of file JqTermTLAD.h.

Here is the call graph for this function:

◆ doFinalizeTraj()

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

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 77 of file JqTermTLAD.h.

◆ doFirstAD()

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

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 170 of file JqTermTLAD.h.

Here is the call graph for this function:

◆ doInitializeTL()

template<typename MODEL >
void oops::JqTermTLAD< MODEL >::doInitializeTL ( const Increment_ &  ,
const util::DateTime &  ,
const util::Duration &   
)
inlineoverrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 50 of file JqTermTLAD.h.

◆ doInitializeTraj()

template<typename MODEL >
void oops::JqTermTLAD< MODEL >::doInitializeTraj ( const State_ &  ,
const util::DateTime &  ,
const util::Duration &   
)
inlineoverrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 45 of file JqTermTLAD.h.

◆ doLastAD()

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

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 57 of file JqTermTLAD.h.

◆ doProcessingAD()

template<typename MODEL >
void oops::JqTermTLAD< MODEL >::doProcessingAD ( Increment_ &  )
inlineoverrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 56 of file JqTermTLAD.h.

◆ doProcessingTL()

template<typename MODEL >
void oops::JqTermTLAD< MODEL >::doProcessingTL ( const Increment_ &  )
inlineoverrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 52 of file JqTermTLAD.h.

◆ doProcessingTraj()

template<typename MODEL >
void oops::JqTermTLAD< MODEL >::doProcessingTraj ( const State_ &  )
inlineoverrideprivatevirtual

Implements oops::PostBaseTLAD< MODEL >.

Definition at line 47 of file JqTermTLAD.h.

◆ getMxi()

template<typename MODEL >
State< MODEL > & oops::JqTermTLAD< MODEL >::getMxi

Definition at line 121 of file JqTermTLAD.h.

◆ setupAD()

template<typename MODEL >
void oops::JqTermTLAD< MODEL >::setupAD ( const Increment_ &  dx)

Definition at line 160 of file JqTermTLAD.h.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ commTime_

template<typename MODEL >
const eckit::mpi::Comm& oops::JqTermTLAD< MODEL >::commTime_
private

Definition at line 59 of file JqTermTLAD.h.

◆ mxi_

template<typename MODEL >
std::unique_ptr<Increment_> oops::JqTermTLAD< MODEL >::mxi_
private

Definition at line 61 of file JqTermTLAD.h.

◆ xi_

template<typename MODEL >
std::unique_ptr<Increment_> oops::JqTermTLAD< MODEL >::xi_
private

Definition at line 62 of file JqTermTLAD.h.

◆ xtraj_

template<typename MODEL >
std::unique_ptr<State_> oops::JqTermTLAD< MODEL >::xtraj_
private

Definition at line 60 of file JqTermTLAD.h.

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