Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Tempus_Test::SinCosModel< Scalar > Class Template Reference

Sine-Cosine model problem from Rythmos. This is a canonical Sine-Cosine differential equation. More...

#include <SinCosModel_decl.hpp>

Inheritance diagram for Tempus_Test::SinCosModel< Scalar >:
Tempus_Test::SinCosModelAdjoint< Scalar >

Public Member Functions

 SinCosModel (Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
 
Thyra::ModelEvaluatorBase::InArgs< Scalar > getExactSolution (double t) const
 
Thyra::ModelEvaluatorBase::InArgs< Scalar > getExactSensSolution (int j, double t) const
 

Private functions overridden from ModelEvaluatorDefaultBase.

int dim_
 Number of state unknowns (2)
 
int Np_
 Number of parameter vectors (1)
 
int np_
 Number of parameters in this vector (2)
 
int Ng_
 Number of observation functions (1)
 
int ng_
 Number of elements in this observation function (1)
 
bool haveIC_
 false => no nominal values are provided (default=true)
 
bool acceptModelParams_
 Changes inArgs to require parameters.
 
bool useDfDpAsTangent_
 Treat DfDp OutArg as tangent (df/dx*dx/dp+df/dp)
 
bool isInitialized_
 
Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs_
 
Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs_
 
Thyra::ModelEvaluatorBase::InArgs< Scalar > nominalValues_
 
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > x_space_
 
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > f_space_
 
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > p_space_
 
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > g_space_
 
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > DxDp_space_
 
Scalar a_
 Model parameter.
 
Scalar f_
 Model parameter.
 
Scalar L_
 Model parameter.
 
Scalar phi_
 Parameter determined from the IC.
 
Scalar b_
 Parameter determined from the IC.
 
Scalar t0_ic_
 Time value where the initial condition is specified.
 
Scalar x0_ic_
 Initial condition for x0.
 
Scalar x1_ic_
 Initial condition for x1.
 
Thyra::ModelEvaluatorBase::OutArgs< Scalar > createOutArgsImpl () const
 
void evalModelImpl (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs_bar, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs_bar) const
 
void calculateCoeffFromIC_ ()
 

Public functions overridden from ModelEvaluator.

Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space () const
 
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_f_space () const
 
Thyra::ModelEvaluatorBase::InArgs< Scalar > getNominalValues () const
 
Teuchos::RCP< Thyra::LinearOpWithSolveBase< Scalar > > create_W () const
 
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_W_op () const
 
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > get_W_factory () const
 
Thyra::ModelEvaluatorBase::InArgs< Scalar > createInArgs () const
 
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_p_space (int l) const
 
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names (int l) const
 
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_g_space (int j) const
 

Public functions overridden from ParameterListAcceptor.

void setParameterList (Teuchos::RCP< Teuchos::ParameterList > const &paramList)
 
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters () const
 
void setupInOutArgs_ () const
 

Detailed Description

template<class Scalar>
class Tempus_Test::SinCosModel< Scalar >

Sine-Cosine model problem from Rythmos. This is a canonical Sine-Cosine differential equation.

\[ \mathbf{\ddot{x}}=-\mathbf{x} \]

with a few enhancements. We start with the exact solution to the differential equation

\begin{eqnarray*} x_{0}(t) & = & a+b*\sin((f/L)*t+\phi)\\ x_{1}(t) & = & b*(f/L)*\cos((f/L)*t+\phi) \end{eqnarray*}

then the form of the model is

\begin{eqnarray*} \frac{d}{dt}x_{0}(t) & = & x_{1}(t)\\ \frac{d}{dt}x_{1}(t) & = & \left(\frac{f}{L}\right)^{2}(a-x_{0}(t)) \end{eqnarray*}

where the default parameter values are $a=0$, $f=1$, and $L=1$, and the initial conditions

\begin{eqnarray*} x_{0}(t_{0}=0) & = & \gamma_{0}[=0]\\ x_{1}(t_{0}=0) & = & \gamma_{1}[=1] \end{eqnarray*}

determine the remaining coefficients

\begin{eqnarray*} \phi & = & \arctan(((f/L)/\gamma_{1})*(\gamma_{0}-a))-(f/L)*t_{0}[=0]\\ b & = & \gamma_{1}/((f/L)*cos((f/L)*t_{0}+\phi))[=1] \end{eqnarray*}

Therefore this model has three model parameters and two initial conditions which effect the exact solution as above.

\[ \mathbf{p}=(a,f,L) \]

\[ \dot{\mathbf{x}}=\mathbf{F}(\mathbf{x},t,\mathbf{p}) \]

where

\begin{eqnarray*} F_{0} & = & x_{1}\\ F_{1} & = & \left(\frac{f}{L}\right)^{2}(a-x_{0}) \end{eqnarray*}

The exact sensitivities, $\mathbf{s}=\partial\mathbf{x}/\partial\mathbf{p}$, for the problem are specified as

\[ \mathbf{s}(t)=\left[\begin{array}{cc} 1 & 0\\ \left(\frac{b}{L}\right)t\,\cos\left(\left(\frac{f}{L}\right)t+\phi\right) & \left(\frac{b}{L}\right)\cos\left(\left(\frac{f}{L}\right)t+\phi\right)-\frac{b\, f\, t}{L^{2}}\sin\left(\left(\frac{f}{L}\right)t+\phi\right)\\ -\frac{b\, f\, t}{L^{2}}\cos\left(\left(\frac{f}{L}\right)t+\phi\right) & -\frac{b\, f}{L^{2}}\cos\left(\left(\frac{f}{L}\right)t+\phi\right)+\frac{b\, f^{2}\, t}{L^{3}}\sin\left(\left(\frac{f}{L}\right)t+\phi\right) \end{array}\right] \]

and for the default initial conditions, $\phi=0$ and $b=1$

\[ \mathbf{s}(t=0)=\left[\begin{array}{cc} 1 & 0\\ 0 & \frac{b}{L}\\ 0 & -\frac{f}{L^{2}} \end{array}\right] \]

The time differentiated sensitivities, $\dot{\mathbf{s}}=\partial\mathbf{s}/\partial t=\partial/\partial t(\partial\mathbf{x}/\partial\mathbf{p})=\partial/\partial\mathbf{p}(\partial\mathbf{x}/\partial t)$ are

\[ \dot{\mathbf{s}}(t)=\left[\begin{array}{cc} 0 & 0\\ \left(\frac{b}{L}\right)\cos\left(\left(\frac{f}{L}\right)t+\phi\right)-\frac{b\, f\, t}{L^{2}}\sin\left(\left(\frac{f}{L}\right)t+\phi\right) & -\frac{2b\, f}{L^{2}}\sin\left(\left(\frac{f}{L}\right)t+\phi\right)\left(\frac{b}{L}\right)-\frac{b\, f^{2}\, t}{L^{3}}\cos\left(\left(\frac{f}{L}\right)t+\phi\right)\\ -\frac{b\, f}{L^{2}}\cos\left(\left(\frac{f}{L}\right)t+\phi\right)+\frac{b\, f^{2}\, t}{L^{3}}\sin\left(\left(\frac{f}{L}\right)t+\phi\right) & \frac{2b\, f^{2}}{L^{3}}\sin\left(\left(\frac{f}{L}\right)t+\phi\right)+\frac{b\, f^{3}\, t}{L^{4}}\cos\left(\left(\frac{f}{L}\right)t+\phi\right) \end{array}\right] \]

Definition at line 109 of file SinCosModel_decl.hpp.

Constructor & Destructor Documentation

◆ SinCosModel()

template<class Scalar >
Tempus_Test::SinCosModel< Scalar >::SinCosModel ( Teuchos::RCP< Teuchos::ParameterList >  pList = Teuchos::null)

Definition at line 30 of file SinCosModel_impl.hpp.

Member Function Documentation

◆ getExactSolution()

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus_Test::SinCosModel< Scalar >::getExactSolution ( double  t) const

Definition at line 62 of file SinCosModel_impl.hpp.

◆ getExactSensSolution()

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus_Test::SinCosModel< Scalar >::getExactSensSolution ( int  j,
double  t 
) const

Definition at line 98 of file SinCosModel_impl.hpp.

◆ get_x_space()

template<class Scalar >
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus_Test::SinCosModel< Scalar >::get_x_space ( ) const

Definition at line 161 of file SinCosModel_impl.hpp.

◆ get_f_space()

template<class Scalar >
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus_Test::SinCosModel< Scalar >::get_f_space ( ) const

Definition at line 168 of file SinCosModel_impl.hpp.

◆ getNominalValues()

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus_Test::SinCosModel< Scalar >::getNominalValues ( ) const

Definition at line 175 of file SinCosModel_impl.hpp.

◆ create_W()

template<class Scalar >
Teuchos::RCP< Thyra::LinearOpWithSolveBase< Scalar > > Tempus_Test::SinCosModel< Scalar >::create_W ( ) const

Definition at line 184 of file SinCosModel_impl.hpp.

◆ create_W_op()

template<class Scalar >
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > Tempus_Test::SinCosModel< Scalar >::create_W_op ( ) const

Definition at line 227 of file SinCosModel_impl.hpp.

◆ get_W_factory()

template<class Scalar >
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > Tempus_Test::SinCosModel< Scalar >::get_W_factory ( ) const

Definition at line 237 of file SinCosModel_impl.hpp.

◆ createInArgs()

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus_Test::SinCosModel< Scalar >::createInArgs ( ) const

Definition at line 256 of file SinCosModel_impl.hpp.

◆ get_p_space()

template<class Scalar >
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus_Test::SinCosModel< Scalar >::get_p_space ( int  l) const

Definition at line 437 of file SinCosModel_impl.hpp.

◆ get_p_names()

template<class Scalar >
Teuchos::RCP< const Teuchos::Array< std::string > > Tempus_Test::SinCosModel< Scalar >::get_p_names ( int  l) const

Definition at line 452 of file SinCosModel_impl.hpp.

◆ get_g_space()

template<class Scalar >
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus_Test::SinCosModel< Scalar >::get_g_space ( int  j) const

Definition at line 474 of file SinCosModel_impl.hpp.

◆ setParameterList()

template<class Scalar >
void Tempus_Test::SinCosModel< Scalar >::setParameterList ( Teuchos::RCP< Teuchos::ParameterList > const &  paramList)

Definition at line 556 of file SinCosModel_impl.hpp.

◆ getValidParameters()

template<class Scalar >
Teuchos::RCP< const Teuchos::ParameterList > Tempus_Test::SinCosModel< Scalar >::getValidParameters ( ) const

Definition at line 588 of file SinCosModel_impl.hpp.

◆ setupInOutArgs_()

template<class Scalar >
void Tempus_Test::SinCosModel< Scalar >::setupInOutArgs_ ( ) const
private

Definition at line 483 of file SinCosModel_impl.hpp.

◆ createOutArgsImpl()

template<class Scalar >
Thyra::ModelEvaluatorBase::OutArgs< Scalar > Tempus_Test::SinCosModel< Scalar >::createOutArgsImpl ( ) const
private

Definition at line 267 of file SinCosModel_impl.hpp.

◆ evalModelImpl()

template<class Scalar >
void Tempus_Test::SinCosModel< Scalar >::evalModelImpl ( const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  inArgs_bar,
const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &  outArgs_bar 
) const
private

Definition at line 274 of file SinCosModel_impl.hpp.

◆ calculateCoeffFromIC_()

template<class Scalar >
void Tempus_Test::SinCosModel< Scalar >::calculateCoeffFromIC_ ( )
private

Definition at line 612 of file SinCosModel_impl.hpp.

Member Data Documentation

◆ dim_

template<class Scalar >
int Tempus_Test::SinCosModel< Scalar >::dim_
protected

Number of state unknowns (2)

Definition at line 160 of file SinCosModel_decl.hpp.

◆ Np_

template<class Scalar >
int Tempus_Test::SinCosModel< Scalar >::Np_
protected

Number of parameter vectors (1)

Definition at line 161 of file SinCosModel_decl.hpp.

◆ np_

template<class Scalar >
int Tempus_Test::SinCosModel< Scalar >::np_
protected

Number of parameters in this vector (2)

Definition at line 162 of file SinCosModel_decl.hpp.

◆ Ng_

template<class Scalar >
int Tempus_Test::SinCosModel< Scalar >::Ng_
protected

Number of observation functions (1)

Definition at line 163 of file SinCosModel_decl.hpp.

◆ ng_

template<class Scalar >
int Tempus_Test::SinCosModel< Scalar >::ng_
protected

Number of elements in this observation function (1)

Definition at line 164 of file SinCosModel_decl.hpp.

◆ haveIC_

template<class Scalar >
bool Tempus_Test::SinCosModel< Scalar >::haveIC_
protected

false => no nominal values are provided (default=true)

Definition at line 165 of file SinCosModel_decl.hpp.

◆ acceptModelParams_

template<class Scalar >
bool Tempus_Test::SinCosModel< Scalar >::acceptModelParams_
protected

Changes inArgs to require parameters.

Definition at line 166 of file SinCosModel_decl.hpp.

◆ useDfDpAsTangent_

template<class Scalar >
bool Tempus_Test::SinCosModel< Scalar >::useDfDpAsTangent_
protected

Treat DfDp OutArg as tangent (df/dx*dx/dp+df/dp)

Definition at line 167 of file SinCosModel_decl.hpp.

◆ isInitialized_

template<class Scalar >
bool Tempus_Test::SinCosModel< Scalar >::isInitialized_
mutableprotected

Definition at line 168 of file SinCosModel_decl.hpp.

◆ inArgs_

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus_Test::SinCosModel< Scalar >::inArgs_
mutableprotected

Definition at line 169 of file SinCosModel_decl.hpp.

◆ outArgs_

template<class Scalar >
Thyra::ModelEvaluatorBase::OutArgs<Scalar> Tempus_Test::SinCosModel< Scalar >::outArgs_
mutableprotected

Definition at line 170 of file SinCosModel_decl.hpp.

◆ nominalValues_

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus_Test::SinCosModel< Scalar >::nominalValues_
mutableprotected

Definition at line 171 of file SinCosModel_decl.hpp.

◆ x_space_

template<class Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus_Test::SinCosModel< Scalar >::x_space_
protected

Definition at line 172 of file SinCosModel_decl.hpp.

◆ f_space_

template<class Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus_Test::SinCosModel< Scalar >::f_space_
protected

Definition at line 173 of file SinCosModel_decl.hpp.

◆ p_space_

template<class Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus_Test::SinCosModel< Scalar >::p_space_
protected

Definition at line 174 of file SinCosModel_decl.hpp.

◆ g_space_

template<class Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus_Test::SinCosModel< Scalar >::g_space_
protected

Definition at line 175 of file SinCosModel_decl.hpp.

◆ DxDp_space_

template<class Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus_Test::SinCosModel< Scalar >::DxDp_space_
protected

Definition at line 176 of file SinCosModel_decl.hpp.

◆ a_

template<class Scalar >
Scalar Tempus_Test::SinCosModel< Scalar >::a_
protected

Model parameter.

Definition at line 180 of file SinCosModel_decl.hpp.

◆ f_

template<class Scalar >
Scalar Tempus_Test::SinCosModel< Scalar >::f_
protected

Model parameter.

Definition at line 181 of file SinCosModel_decl.hpp.

◆ L_

template<class Scalar >
Scalar Tempus_Test::SinCosModel< Scalar >::L_
protected

Model parameter.

Definition at line 182 of file SinCosModel_decl.hpp.

◆ phi_

template<class Scalar >
Scalar Tempus_Test::SinCosModel< Scalar >::phi_
protected

Parameter determined from the IC.

Definition at line 183 of file SinCosModel_decl.hpp.

◆ b_

template<class Scalar >
Scalar Tempus_Test::SinCosModel< Scalar >::b_
protected

Parameter determined from the IC.

Definition at line 184 of file SinCosModel_decl.hpp.

◆ t0_ic_

template<class Scalar >
Scalar Tempus_Test::SinCosModel< Scalar >::t0_ic_
protected

Time value where the initial condition is specified.

Definition at line 185 of file SinCosModel_decl.hpp.

◆ x0_ic_

template<class Scalar >
Scalar Tempus_Test::SinCosModel< Scalar >::x0_ic_
protected

Initial condition for x0.

Definition at line 186 of file SinCosModel_decl.hpp.

◆ x1_ic_

template<class Scalar >
Scalar Tempus_Test::SinCosModel< Scalar >::x1_ic_
protected

Initial condition for x1.

Definition at line 187 of file SinCosModel_decl.hpp.

The documentation for this class was generated from the following files:
Generated on Thu Oct 9 2025 20:59:11 for Tempus by doxygen 1.9.8