AMP::TimeIntegrator::IDATimeIntegratorParameters Class Reference

TimeIntegratorParameters is a base class for providing parameters for the TimeIntegrator's. The Database object contained must contain the following entries: More...

#include <IDATimeIntegratorParameters.h>

Inheritance diagram for AMP::TimeIntegrator::IDATimeIntegratorParameters:

Public Types
typedef std::shared_ptr< AMP::TimeIntegrator::TimeIntegratorParameters >	shared_ptr
	Convience typedef.

Public Member Functions
	IDATimeIntegratorParameters (std::shared_ptr< AMP::Database > db)
virtual	~IDATimeIntegratorParameters ()

Public Attributes
std::shared_ptr< AMP::Database >	d_db
std::shared_ptr< AMP::Database >	d_global_db
	pointer to global database
std::shared_ptr< AMP::LinearAlgebra::Vector >	d_ic_vector
std::shared_ptr< AMP::LinearAlgebra::Vector >	d_ic_vector_prime
std::shared_ptr< AMP::Mesh::Mesh >	d_Mesh
	Optional mesh for the operator.
std::string	d_name
std::shared_ptr< AMP::Operator::Operator >	d_operator
std::shared_ptr< AMP::LinearAlgebra::Variable >	d_pAlgebraicVariable
std::shared_ptr< IDATimeOperator >	d_pIDATimeOperator
std::shared_ptr< AMP::Operator::LinearOperator >	d_pLinearOperator
std::shared_ptr< LinearTimeOperator >	d_pLinearTimeOperator
std::shared_ptr< TimeOperatorParameters >	d_pLinearTimeOperatorParameters
std::shared_ptr< AMP::Operator::Operator >	d_pMassOperator
std::shared_ptr< AMP::Solver::SolverStrategy >	d_pNestedSolver
std::shared_ptr< AMP::Operator::Operator >	d_pOperator
	Allow for the case that a fully constructed operator is returned.
std::shared_ptr< AMP::LinearAlgebra::Vector >	d_pSourceTerm
std::shared_ptr< AMP::Operator::Operator >	d_temp_operator_1
std::shared_ptr< AMP::Operator::Operator >	d_temp_operator_2

Private Member Functions
	IDATimeIntegratorParameters ()=delete
	IDATimeIntegratorParameters (const IDATimeIntegratorParameters &)
void	operator= (const IDATimeIntegratorParameters &)

Detailed Description

TimeIntegratorParameters is a base class for providing parameters for the TimeIntegrator's. The Database object contained must contain the following entries:

Required input keys and data types:

Parameters

initial_time	double value for the initial simulation time.
final_time	double value for the final simulation time.
max_integrator_steps	integer value for the maximum number of timesteps allowed.

All input data items described above, except for initial_time, may be overwritten by new input values when continuing from restart.

Definition at line 46 of file IDATimeIntegratorParameters.h.

Member Typedef Documentation

shared_ptr

typedef std::shared_ptr<AMP::TimeIntegrator::TimeIntegratorParameters> AMP::TimeIntegrator::TimeIntegratorParameters::shared_ptr

inherited

Convience typedef.

Definition at line 36 of file TimeIntegratorParameters.h.

Constructor & Destructor Documentation

IDATimeIntegratorParameters() [1/3]

AMP::TimeIntegrator::IDATimeIntegratorParameters::IDATimeIntegratorParameters ( std::shared_ptr< AMP::Database >  db )

explicit

~IDATimeIntegratorParameters()

virtual AMP::TimeIntegrator::IDATimeIntegratorParameters::~IDATimeIntegratorParameters ( )

virtual

IDATimeIntegratorParameters() [2/3]

AMP::TimeIntegrator::IDATimeIntegratorParameters::IDATimeIntegratorParameters ( )

explicitprivatedelete

IDATimeIntegratorParameters() [3/3]

AMP::TimeIntegrator::IDATimeIntegratorParameters::IDATimeIntegratorParameters ( const IDATimeIntegratorParameters &  )

explicitprivate

Member Function Documentation

operator=()

void AMP::TimeIntegrator::IDATimeIntegratorParameters::operator= ( const IDATimeIntegratorParameters &  )

private

Member Data Documentation

d_db

std::shared_ptr<AMP::Database> AMP::ParameterBase::d_db

inherited

Definition at line 27 of file ParameterBase.h.

d_global_db

std::shared_ptr<AMP::Database> AMP::TimeIntegrator::TimeIntegratorParameters::d_global_db

inherited

pointer to global database

Definition at line 73 of file TimeIntegratorParameters.h.

d_ic_vector

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::TimeIntegrator::TimeIntegratorParameters::d_ic_vector

inherited

Initial conditions vector

Definition at line 47 of file TimeIntegratorParameters.h.

d_ic_vector_prime

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::TimeIntegrator::IDATimeIntegratorParameters::d_ic_vector_prime

Definition at line 54 of file IDATimeIntegratorParameters.h.

d_Mesh

std::shared_ptr<AMP::Mesh::Mesh> AMP::Operator::OperatorParameters::d_Mesh

inherited

Optional mesh for the operator.

Definition at line 39 of file OperatorParameters.h.

d_name

std::string AMP::ParameterBase::d_name

inherited

Definition at line 25 of file ParameterBase.h.

d_operator

std::shared_ptr<AMP::Operator::Operator> AMP::TimeIntegrator::TimeIntegratorParameters::d_operator

inherited

The operator is the right hand side operator for an explicit integrator when the time integration problem is : u_t = f(u) but in the case of implicit time integrators the operator represents u_t-f(u)

Definition at line 60 of file TimeIntegratorParameters.h.

d_pAlgebraicVariable

std::shared_ptr<AMP::LinearAlgebra::Variable> AMP::TimeIntegrator::TimeIntegratorParameters::d_pAlgebraicVariable

inherited

algebraic variable

Definition at line 70 of file TimeIntegratorParameters.h.

d_pIDATimeOperator

std::shared_ptr<IDATimeOperator> AMP::TimeIntegrator::IDATimeIntegratorParameters::d_pIDATimeOperator

Definition at line 57 of file IDATimeIntegratorParameters.h.

d_pLinearOperator

std::shared_ptr<AMP::Operator::LinearOperator> AMP::TimeIntegrator::IDATimeIntegratorParameters::d_pLinearOperator

Definition at line 62 of file IDATimeIntegratorParameters.h.

d_pLinearTimeOperator

std::shared_ptr<LinearTimeOperator> AMP::TimeIntegrator::IDATimeIntegratorParameters::d_pLinearTimeOperator

Definition at line 58 of file IDATimeIntegratorParameters.h.

d_pLinearTimeOperatorParameters

std::shared_ptr<TimeOperatorParameters> AMP::TimeIntegrator::IDATimeIntegratorParameters::d_pLinearTimeOperatorParameters

Definition at line 59 of file IDATimeIntegratorParameters.h.

d_pMassOperator

std::shared_ptr<AMP::Operator::Operator> AMP::TimeIntegrator::TimeIntegratorParameters::d_pMassOperator

inherited

The operator is the left hand side mass operator (for FEM formulations)

Definition at line 65 of file TimeIntegratorParameters.h.

d_pNestedSolver

std::shared_ptr<AMP::Solver::SolverStrategy> AMP::TimeIntegrator::IDATimeIntegratorParameters::d_pNestedSolver

Definition at line 61 of file IDATimeIntegratorParameters.h.

d_pOperator

std::shared_ptr<AMP::Operator::Operator> AMP::Operator::OperatorParameters::d_pOperator

inherited

Allow for the case that a fully constructed operator is returned.

Definition at line 42 of file OperatorParameters.h.

d_pSourceTerm

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::TimeIntegrator::TimeIntegratorParameters::d_pSourceTerm

inherited

source term for time integration, can also include boundary conditions for IBVP problems

Definition at line 52 of file TimeIntegratorParameters.h.

d_temp_operator_1

std::shared_ptr<AMP::Operator::Operator> AMP::TimeIntegrator::IDATimeIntegratorParameters::d_temp_operator_1

Definition at line 67 of file IDATimeIntegratorParameters.h.

d_temp_operator_2

std::shared_ptr<AMP::Operator::Operator> AMP::TimeIntegrator::IDATimeIntegratorParameters::d_temp_operator_2

Definition at line 68 of file IDATimeIntegratorParameters.h.

---

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

• src/time_integrators/sundials/IDATimeIntegratorParameters.h