#include <IDATimeIntegrator.h>

Inheritance diagram for AMP::TimeIntegrator::IDATimeIntegrator:

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

Public Member Functions
int	advanceSolution (const double dt, const bool first_step, std::shared_ptr< AMP::LinearAlgebra::Vector > in, std::shared_ptr< AMP::LinearAlgebra::Vector > out) override
	Integrate through the specified time increment.

virtual void	appendRhsVector (AMP::LinearAlgebra::Vector::shared_ptr vec)
	Append the vectors of interest to the rhs vector.

virtual void	appendSolutionVector (AMP::LinearAlgebra::Vector::shared_ptr vec)
	Append the vectors of interest to the solution vector.

bool	checkNewSolution (void) override

bool	getBoolManufacturedProblem (void)

virtual double	getCurrentDt () const
	Return current timestep.

virtual double	getCurrentTime () const
	Return final integration time.

virtual double	getFinalTime () const
	Return final integration time.

virtual double	getGamma (void)

uint64_t	getID () const
	Get a unique id hash for the vector.

void *	getIDAMem (void)

std::shared_ptr< IDATimeOperator >	getIDATimeOperator () const

virtual double	getInitialDt ()

virtual double	getInitialTime () const
	Return initial integration time.

virtual int	getIntegratorStep () const
	Return current integration step number.

std::shared_ptr< LinearTimeOperator >	getLinearTimeOperator () const

virtual int	getMaxIntegratorSteps () const
	Return maximum number of integration steps.

double	getNextDt (const bool good_solution) override

std::shared_ptr< AMP::Operator::Operator >	getOperator (void)

std::shared_ptr< AMP::Solver::SolverStrategy >	getPreconditioner (void)

std::shared_ptr< AMP::LinearAlgebra::Vector >	getResidualVector () const

virtual std::shared_ptr< AMP::LinearAlgebra::Vector >	getSolution (void)

std::shared_ptr< AMP::LinearAlgebra::Vector >	getSourceTerm () override

virtual std::vector< double >	getTimeHistoryScalings (void)
	Scaling factors for previous time history vectors.

virtual int	getTotalRejectedSteps () const

	IDATimeIntegrator (std::shared_ptr< TimeIntegratorParameters > parameters)

void	initialize (std::shared_ptr< TimeIntegratorParameters > parameters) override

void	printClassData (std::ostream &os) const

virtual void	printStatistics (std::ostream &os=AMP::pout)

void	putToDatabase (std::shared_ptr< AMP::Database > db)

virtual void	registerChildObjects (AMP::IO::RestartManager *manager) const
	Register any child objects.

virtual void	registerOperator (std::shared_ptr< AMP::Operator::Operator > op)

virtual void	registerWriter (std::shared_ptr< AMP::IO::Writer > writer)
	Registers a writer with the solver.

void	reset (std::shared_ptr< const TimeIntegratorParameters > parameters) override

virtual void	setCurrentDt (const double dt)

virtual void	setCurrentTime (const double t)

virtual void	setFinalTime (const double t)

virtual void	setInitialDt (const double dt)

void	setInitialGuess (const bool first_step, const double current_time, const double current_dt, const double old_dt)

virtual void	setInitialTime (const double t)

virtual void	setSourceTerm (AMP::LinearAlgebra::Vector::shared_ptr src)

virtual size_t	sizeOfTimeHistory () const

virtual bool	stepsRemaining () const
	Have the number of integration steps reached the maximum.

std::string	type () const override
	Return the name of the TimeIntegrator.

void	updateSolution (void) override

void	updateSourceTerm (void)

virtual void	writeRestart (int64_t fid) const
	Write restart data to file.

virtual	~IDATimeIntegrator ()

Public Attributes
std::shared_ptr< AMP::LinearAlgebra::Vector >	d_residual

Protected Member Functions
void	getFromRestart ()

Protected Attributes
double	d_current_dt = std::numeric_limits<double>::signaling_NaN()

double	d_current_time = std::numeric_limits<double>::signaling_NaN()

double	d_final_time = std::numeric_limits<double>::signaling_NaN()

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_ic_vector = nullptr

int	d_iDebugPrintInfoLevel = 0

double	d_initial_dt = std::numeric_limits<double>::signaling_NaN()
	initial time increment

double	d_initial_time = std::numeric_limits<double>::signaling_NaN()

bool	d_initialized = false

int	d_integrator_step = 0

double	d_max_dt = std::numeric_limits<double>::max()
	maximum allowable timestep (user defined)

int	d_max_integrator_steps = 0

double	d_min_dt = std::numeric_limits<double>::signaling_NaN()

std::string	d_object_name

double	d_old_dt = std::numeric_limits<double>::signaling_NaN()

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

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

std::shared_ptr< TimeIntegratorParameters >	d_pParameters

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

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_solution_vector

int	d_total_steprejects = 0

std::shared_ptr< AMP::IO::Writer >	d_writer
	keeps track of total number of step rejections

Private Member Functions
void	getFromInput (std::shared_ptr< AMP::Database > input_db)

	IDATimeIntegrator ()

void	initializeIDA ()

void	setupVectors (void)

Static Private Member Functions
static int	IDAPrecSetup (realtype tt, N_Vector yy, N_Vector yp, N_Vector rr, realtype cj, void *user_data, N_Vector tmp1, N_Vector tmp2, N_Vector tmp3)

static int	IDAPrecSolve (realtype tt, N_Vector yy, N_Vector yp, N_Vector rr, N_Vector rvec, N_Vector zvec, realtype cj, realtype delta, void *user_data, N_Vector tmp)

static int	IDAResTrial (realtype tt, N_Vector yy, N_Vector yp, N_Vector rr, void *user_data)

Private Attributes
double	d_absolute_tolerance

bool	d_bCallCalcIC

bool	d_bLinearMassOperator

bool	d_bLinearRhsOperator

bool	d_bManufacturedProblem

bool	d_bUsePreconditioner

bool	d_createLinearOperatorInternally

void *	d_ida_mem

int	d_linear_solver_type

std::shared_ptr< IDATimeOperator >	d_pIDATimeOperator

std::shared_ptr< LinearTimeOperator >	d_pLinearTimeOperator

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

double	d_relative_tolerance

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_solution_prime

Detailed Description

Class IDATimeIntegrator is a concrete time integrator that provides an interface to the IDA time integrator within the SUNDIALS library. It is derived from the TimeIntegrator class. This class is not derived from the ImplicitTimeIntegrator class as it is more an interface or adaptor rather than an implicit time integrator within the AMP package. As such, it uses the nonlinear solvers provided by IDA and cannot leverage the solvers that AMP provides currently other than within preconditioning.

See also: TimeIntegrator

Definition at line 38 of file IDATimeIntegrator.h.

Member Typedef Documentation

◆ shared_ptr

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

inherited

Convience typedef.

Definition at line 37 of file TimeIntegrator.h.

Constructor & Destructor Documentation

◆ IDATimeIntegrator() [1/2]

AMP::TimeIntegrator::IDATimeIntegrator::IDATimeIntegrator ( std::shared_ptr< TimeIntegratorParameters > parameters )

explicit

Main constructor that accepts parameters object. The parameter object must be a TimeIntegratorParameters object.The database object within the parameter object expects the following fields in addition to any fields expected by the TimeIntegrator base class.

name: bLinearMassOperator description: boolean to indicate whether the mass operator is a linear operator, currently either both mass and rhs operators have to be linear or both have to be nonlinear type: bool default value: FALSE valid values: (TRUE, FALSE) optional field: yes
name: bLinearRhsOperator description: boolean to indicate whether the rhs operator is a linear operator, currently either both mass and rhs operators have to be linear or both have to be nonlinear type: bool default value: FALSE valid values: (TRUE, FALSE) optional field: yes
name: relative_tolerance description: relative tolerance for solves in IDA type: double default value: none valid values: see IDA manual optional field: no
name: absolute_tolerance description: absolute tolerance for IDA solves type: double default value: none valid values: see IDA manual optional field: no
name: CallCalcIC description: indicate whether to ask IDA to calculate initial conditions or not type: bool default value: TRUE valid values: (TRUE, FALSE) optional field: yes
name: usePreconditioner description: whether to use preconditioner or not type: bool default value: TRUE valid values: (TRUE, FALSE) optional field: yes
name: description: type: default value: valid values: optional field:
name: createLinearTimeOperatorInternally description: indicate whether the linear operators required by the IDA preconditioner should be constructed internally or whether the user will supply type: bool default value: FALSE valid values: (TRUE, FALSE) optional field: yes
name: bManufacturedProblem description: added by Gary, need to discuss whether appropriate mechanism or not type: default value: valid values: optional field:

◆ ~IDATimeIntegrator()

virtual AMP::TimeIntegrator::IDATimeIntegrator::~IDATimeIntegrator ( )

virtual

Destructor.

◆ IDATimeIntegrator() [2/2]

AMP::TimeIntegrator::IDATimeIntegrator::IDATimeIntegrator ( )

private

Constructor.

Member Function Documentation

◆ advanceSolution()

int AMP::TimeIntegrator::IDATimeIntegrator::advanceSolution	(	const double	dt,
		const bool	first_step,
		std::shared_ptr< AMP::LinearAlgebra::Vector >	in,
		std::shared_ptr< AMP::LinearAlgebra::Vector >	out
	)

overridevirtual

Integrate through the specified time increment.

The boolean first_step argument is true when this is the very first call to the advance function. Otherwise it is false. Note that, when the argument is true, the use of extrapolation to construct the initial guess for the advanced solution may not be possible.

This function may, or may not, copy the new solution into the solution vector at the previous time step (updateSolution). If it is copied, this can reduce the memory requirements, but restricts the implementation to those functions that will not be called multiple times within a time step. If it is not copied, the update solution function must be called after each time step. The concrete implementation needs to make this clear.

Parameters

dt	Time step size
first_step	Whether this is the first step
in	Input vector
out	Output vector

Returns: value is the return code generated by the particular solver package in use

Implements AMP::TimeIntegrator::TimeIntegrator.

◆ appendRhsVector()

virtual void AMP::TimeIntegrator::TimeIntegrator::appendRhsVector ( AMP::LinearAlgebra::Vector::shared_ptr vec )

inlinevirtualinherited

Append the vectors of interest to the rhs vector.

This function will append the necessary vectors that this solver owns to the global vector provided. Note that each solver may own any number of vectors, but no vector may be owned by multiple solvers.

Parameters

vec	The vector to append

Definition at line 219 of file TimeIntegrator.h.

◆ appendSolutionVector()

virtual void AMP::TimeIntegrator::TimeIntegrator::appendSolutionVector ( AMP::LinearAlgebra::Vector::shared_ptr vec )

inlinevirtualinherited

Append the vectors of interest to the solution vector.

This function will append the necessary vectors that this solver owns to the global vector provided. Note that each solver may own any number of vectors, but no vector may be owned by multiple solvers.

Parameters

vec	The vector to append

Definition at line 208 of file TimeIntegrator.h.

◆ checkNewSolution()

bool AMP::TimeIntegrator::IDATimeIntegrator::checkNewSolution ( void )

overridevirtual

Check time advanced solution to determine whether it is acceptable. Return true if the solution is acceptable; return false otherwise. The integer argument is the return code generated by the call to the nonlinear solver "solve" routine. The meaning of this value depends on the particular nonlinear solver in use and must be intepreted properly by the user-supplied solution checking routine.

Implements AMP::TimeIntegrator::TimeIntegrator.

◆ getBoolManufacturedProblem()

bool AMP::TimeIntegrator::IDATimeIntegrator::getBoolManufacturedProblem ( void )

inline

added by Gary, need discussion whether to deprecate

Definition at line 188 of file IDATimeIntegrator.h.

References d_bManufacturedProblem.

◆ getCurrentDt()

virtual double AMP::TimeIntegrator::TimeIntegrator::getCurrentDt ( ) const

virtualinherited

Return current timestep.

◆ getCurrentTime()

virtual double AMP::TimeIntegrator::TimeIntegrator::getCurrentTime ( ) const

virtualinherited

Return final integration time.

Return current integration time.

◆ getFinalTime()

virtual double AMP::TimeIntegrator::TimeIntegrator::getFinalTime ( ) const

virtualinherited

Return final integration time.

◆ getFromInput()

void AMP::TimeIntegrator::IDATimeIntegrator::getFromInput ( std::shared_ptr< AMP::Database > input_db )

private

Read data from input database.

◆ getFromRestart()

void AMP::TimeIntegrator::TimeIntegrator::getFromRestart ( )

protectedinherited

◆ getGamma()

virtual double AMP::TimeIntegrator::TimeIntegrator::getGamma ( void )

inlinevirtualinherited

Reimplemented in AMP::TimeIntegrator::BDFIntegrator.

Definition at line 268 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_current_dt.

◆ getID()

uint64_t AMP::TimeIntegrator::TimeIntegrator::getID ( ) const

inherited

Get a unique id hash for the vector.

◆ getIDAMem()

void * AMP::TimeIntegrator::IDATimeIntegrator::getIDAMem ( void )

inline

return a void * pointer to the IDA_mem data structure used by IDA

Definition at line 206 of file IDATimeIntegrator.h.

References d_ida_mem.

◆ getIDATimeOperator()

std::shared_ptr< IDATimeOperator > AMP::TimeIntegrator::IDATimeIntegrator::getIDATimeOperator ( ) const

return a pointer to the IDA time operator, deprecated

◆ getInitialDt()

virtual double AMP::TimeIntegrator::TimeIntegrator::getInitialDt ( )

inlinevirtualinherited

get initial time step.

Definition at line 179 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_initial_dt.

◆ getInitialTime()

virtual double AMP::TimeIntegrator::TimeIntegrator::getInitialTime ( ) const

virtualinherited

Return initial integration time.

◆ getIntegratorStep()

virtual int AMP::TimeIntegrator::TimeIntegrator::getIntegratorStep ( ) const

virtualinherited

Return current integration step number.

◆ getLinearTimeOperator()

std::shared_ptr< LinearTimeOperator > AMP::TimeIntegrator::IDATimeIntegrator::getLinearTimeOperator ( ) const

return a pointer to the linear time operator used by the preconditioner

◆ getMaxIntegratorSteps()

virtual int AMP::TimeIntegrator::TimeIntegrator::getMaxIntegratorSteps ( ) const

virtualinherited

Return maximum number of integration steps.

◆ getNextDt()

double AMP::TimeIntegrator::IDATimeIntegrator::getNextDt ( const bool good_solution )

overridevirtual

Specify next time step to use.

Reimplemented from AMP::TimeIntegrator::TimeIntegrator.

◆ getOperator()

std::shared_ptr< AMP::Operator::Operator > AMP::TimeIntegrator::TimeIntegrator::getOperator ( void )

inlineinherited

Definition at line 246 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_operator.

◆ getPreconditioner()

std::shared_ptr< AMP::Solver::SolverStrategy > AMP::TimeIntegrator::IDATimeIntegrator::getPreconditioner ( void )

inline

return a shared pointer to the preconditioner being used

Definition at line 198 of file IDATimeIntegrator.h.

References d_pNestedSolver.

◆ getResidualVector()

std::shared_ptr< AMP::LinearAlgebra::Vector > AMP::TimeIntegrator::IDATimeIntegrator::getResidualVector ( ) const

return a shared pointer to the residual vector

◆ getSolution()

virtual std::shared_ptr< AMP::LinearAlgebra::Vector > AMP::TimeIntegrator::TimeIntegrator::getSolution ( void )

inlinevirtualinherited

Retrieve the current solution.

Definition at line 137 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_solution_vector.

◆ getSourceTerm()

std::shared_ptr< AMP::LinearAlgebra::Vector > AMP::TimeIntegrator::IDATimeIntegrator::getSourceTerm ( )

overridevirtual

return a shared pointer to the source term at the current time step

Reimplemented from AMP::TimeIntegrator::TimeIntegrator.

◆ getTimeHistoryScalings()

virtual std::vector< double > AMP::TimeIntegrator::TimeIntegrator::getTimeHistoryScalings ( void )

inlinevirtualinherited

Scaling factors for previous time history vectors.

For RK methods the previous time vector is always scaled by 1. For multistep methods this vector can consist of multiple scalings with the first entry being the scaling for $y^{n-1}$, the next being for $y^{n-2}$ etc

Reimplemented in AMP::TimeIntegrator::BDFIntegrator.

Definition at line 276 of file TimeIntegrator.h.

◆ getTotalRejectedSteps()

virtual int AMP::TimeIntegrator::TimeIntegrator::getTotalRejectedSteps ( ) const

inlinevirtualinherited

Definition at line 248 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_total_steprejects.

◆ IDAPrecSetup()

static int AMP::TimeIntegrator::IDATimeIntegrator::IDAPrecSetup	(	realtype	tt,
		N_Vector	yy,
		N_Vector	yp,
		N_Vector	rr,
		realtype	cj,
		void *	user_data,
		N_Vector	tmp1,
		N_Vector	tmp2,
		N_Vector	tmp3
	)

staticprivate

◆ IDAPrecSolve()

static int AMP::TimeIntegrator::IDATimeIntegrator::IDAPrecSolve	(	realtype	tt,
		N_Vector	yy,
		N_Vector	yp,
		N_Vector	rr,
		N_Vector	rvec,
		N_Vector	zvec,
		realtype	cj,
		realtype	delta,
		void *	user_data,
		N_Vector	tmp
	)

staticprivate

◆ IDAResTrial()

static int AMP::TimeIntegrator::IDATimeIntegrator::IDAResTrial	(	realtype	tt,
		N_Vector	yy,
		N_Vector	yp,
		N_Vector	rr,
		void *	user_data
	)

staticprivate

◆ initialize()

void AMP::TimeIntegrator::IDATimeIntegrator::initialize ( std::shared_ptr< TimeIntegratorParameters > parameters )

overridevirtual

Initialize from parameter list.

Reimplemented from AMP::TimeIntegrator::TimeIntegrator.

◆ initializeIDA()

void AMP::TimeIntegrator::IDATimeIntegrator::initializeIDA ( )

private

◆ printClassData()

void AMP::TimeIntegrator::TimeIntegrator::printClassData ( std::ostream & os ) const

inherited

Print out all members of integrator instance to given output stream.

◆ printStatistics()

virtual void AMP::TimeIntegrator::TimeIntegrator::printStatistics ( std::ostream & os = AMP::pout )

virtualinherited

Reimplemented in AMP::TimeIntegrator::BDFIntegrator, and AMP::TimeIntegrator::ImplicitIntegrator.

◆ putToDatabase()

void AMP::TimeIntegrator::TimeIntegrator::putToDatabase ( std::shared_ptr< AMP::Database > db )

inherited

Write out state of object to given database.

When assertion checking is active, the database pointer must be non-null.

◆ registerChildObjects()

virtual void AMP::TimeIntegrator::TimeIntegrator::registerChildObjects ( AMP::IO::RestartManager * manager ) const

virtualinherited

Register any child objects.

This function will register child objects with the manager

Parameters

manager Restart manager

Reimplemented in AMP::TimeIntegrator::BDFIntegrator, AMP::TimeIntegrator::ImplicitIntegrator, AMP::TimeIntegrator::RK12TimeIntegrator, AMP::TimeIntegrator::RK23TimeIntegrator, AMP::TimeIntegrator::RK2TimeIntegrator, AMP::TimeIntegrator::RK34TimeIntegrator, AMP::TimeIntegrator::RK45TimeIntegrator, and AMP::TimeIntegrator::RK4TimeIntegrator.

◆ registerOperator()

virtual void AMP::TimeIntegrator::TimeIntegrator::registerOperator ( std::shared_ptr< AMP::Operator::Operator > op )

inlinevirtualinherited

Reimplemented in AMP::TimeIntegrator::ImplicitIntegrator.

Definition at line 241 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_operator.

◆ registerWriter()

virtual void AMP::TimeIntegrator::TimeIntegrator::registerWriter ( std::shared_ptr< AMP::IO::Writer > writer )

inlinevirtualinherited

Registers a writer with the solver.

This function will register a writer with the solver. The solver may then register any vector components it "owns" with the writer.

Parameters

writer The writer to register

Definition at line 227 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_writer.

◆ reset()

void AMP::TimeIntegrator::IDATimeIntegrator::reset ( std::shared_ptr< const TimeIntegratorParameters > parameters )

overridevirtual

Resets the internal state of the time integrator as needed. A parameter argument is passed to allow for general flexibility in determining what needs to be reset Typically used after a regrid.

Implements AMP::TimeIntegrator::TimeIntegrator.

◆ setCurrentDt()

virtual void AMP::TimeIntegrator::TimeIntegrator::setCurrentDt ( const double dt )

inlinevirtualinherited

Definition at line 250 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_current_dt.

◆ setCurrentTime()

virtual void AMP::TimeIntegrator::TimeIntegrator::setCurrentTime ( const double t )

inlinevirtualinherited

Definition at line 254 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_current_time.

◆ setFinalTime()

virtual void AMP::TimeIntegrator::TimeIntegrator::setFinalTime ( const double t )

inlinevirtualinherited

Definition at line 258 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_final_time.

◆ setInitialDt()

virtual void AMP::TimeIntegrator::TimeIntegrator::setInitialDt ( const double dt )

inlinevirtualinherited

Definition at line 252 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_initial_dt.

◆ setInitialGuess()

void AMP::TimeIntegrator::IDATimeIntegrator::setInitialGuess	(	const bool	first_step,
		const double	current_time,
		const double	current_dt,
		const double	old_dt
	)

Set an initial guess for the time advanced solution.

◆ setInitialTime()

virtual void AMP::TimeIntegrator::TimeIntegrator::setInitialTime ( const double t )

inlinevirtualinherited

Definition at line 256 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_initial_time.

◆ setSourceTerm()

virtual void AMP::TimeIntegrator::TimeIntegrator::setSourceTerm ( AMP::LinearAlgebra::Vector::shared_ptr src )

inlinevirtualinherited

Definition at line 262 of file TimeIntegrator.h.

References AMP::TimeIntegrator::TimeIntegrator::d_pSourceTerm.

◆ setupVectors()

void AMP::TimeIntegrator::IDATimeIntegrator::setupVectors ( void )

private

◆ sizeOfTimeHistory()

virtual size_t AMP::TimeIntegrator::TimeIntegrator::sizeOfTimeHistory ( ) const

inlinevirtualinherited

Reimplemented in AMP::TimeIntegrator::BDFIntegrator.

Definition at line 284 of file TimeIntegrator.h.

◆ stepsRemaining()

virtual bool AMP::TimeIntegrator::TimeIntegrator::stepsRemaining ( ) const

virtualinherited

Have the number of integration steps reached the maximum.

Return true if the number of integration steps performed by the integrator has not reached the specified maximum; return false otherwise.

Reimplemented in AMP::TimeIntegrator::ImplicitIntegrator.

◆ type()

std::string AMP::TimeIntegrator::IDATimeIntegrator::type ( ) const

inlineoverridevirtual

Return the name of the TimeIntegrator.

Reimplemented from AMP::TimeIntegrator::TimeIntegrator.

Definition at line 208 of file IDATimeIntegrator.h.

◆ updateSolution()

void AMP::TimeIntegrator::IDATimeIntegrator::updateSolution ( void )

overridevirtual

Update state of the solution.

Implements AMP::TimeIntegrator::TimeIntegrator.

◆ updateSourceTerm()

void AMP::TimeIntegrator::IDATimeIntegrator::updateSourceTerm ( void )

◆ writeRestart()

virtual void AMP::TimeIntegrator::TimeIntegrator::writeRestart ( int64_t fid ) const

virtualinherited

Write restart data to file.

This function will write the mesh to an HDF5 file

Parameters

fid	File identifier to write

Reimplemented in AMP::TimeIntegrator::BDFIntegrator, AMP::TimeIntegrator::ImplicitIntegrator, AMP::TimeIntegrator::RK12TimeIntegrator, AMP::TimeIntegrator::RK23TimeIntegrator, AMP::TimeIntegrator::RK2TimeIntegrator, AMP::TimeIntegrator::RK34TimeIntegrator, AMP::TimeIntegrator::RK45TimeIntegrator, and AMP::TimeIntegrator::RK4TimeIntegrator.

Member Data Documentation

◆ d_absolute_tolerance

double AMP::TimeIntegrator::IDATimeIntegrator::d_absolute_tolerance

private

Definition at line 260 of file IDATimeIntegrator.h.

◆ d_bCallCalcIC

bool AMP::TimeIntegrator::IDATimeIntegrator::d_bCallCalcIC

private

Definition at line 265 of file IDATimeIntegrator.h.

◆ d_bLinearMassOperator

bool AMP::TimeIntegrator::IDATimeIntegrator::d_bLinearMassOperator

private

Definition at line 273 of file IDATimeIntegrator.h.

◆ d_bLinearRhsOperator

bool AMP::TimeIntegrator::IDATimeIntegrator::d_bLinearRhsOperator

private

Definition at line 274 of file IDATimeIntegrator.h.

◆ d_bManufacturedProblem

bool AMP::TimeIntegrator::IDATimeIntegrator::d_bManufacturedProblem

private

Definition at line 275 of file IDATimeIntegrator.h.

Referenced by getBoolManufacturedProblem().

◆ d_bUsePreconditioner

bool AMP::TimeIntegrator::IDATimeIntegrator::d_bUsePreconditioner

private

Definition at line 271 of file IDATimeIntegrator.h.

◆ d_createLinearOperatorInternally

bool AMP::TimeIntegrator::IDATimeIntegrator::d_createLinearOperatorInternally

private

Definition at line 268 of file IDATimeIntegrator.h.

◆ d_current_dt

double AMP::TimeIntegrator::TimeIntegrator::d_current_dt = std::numeric_limits<double>::signaling_NaN()

protectedinherited

Definition at line 350 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::TimeIntegrator::getGamma(), and AMP::TimeIntegrator::TimeIntegrator::setCurrentDt().

◆ d_current_time

double AMP::TimeIntegrator::TimeIntegrator::d_current_time = std::numeric_limits<double>::signaling_NaN()

protectedinherited

Definition at line 346 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::TimeIntegrator::setCurrentTime().

◆ d_final_time

double AMP::TimeIntegrator::TimeIntegrator::d_final_time = std::numeric_limits<double>::signaling_NaN()

protectedinherited

Definition at line 345 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::TimeIntegrator::setFinalTime().

◆ d_ic_vector

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::TimeIntegrator::TimeIntegrator::d_ic_vector = nullptr

protectedinherited

Definition at line 315 of file TimeIntegrator.h.

◆ d_ida_mem

void* AMP::TimeIntegrator::IDATimeIntegrator::d_ida_mem

private

Definition at line 257 of file IDATimeIntegrator.h.

Referenced by getIDAMem().

◆ d_iDebugPrintInfoLevel

int AMP::TimeIntegrator::TimeIntegrator::d_iDebugPrintInfoLevel = 0

protectedinherited

Definition at line 357 of file TimeIntegrator.h.

◆ d_initial_dt

double AMP::TimeIntegrator::TimeIntegrator::d_initial_dt = std::numeric_limits<double>::signaling_NaN()

protectedinherited

initial time increment

Definition at line 349 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::TimeIntegrator::getInitialDt(), and AMP::TimeIntegrator::TimeIntegrator::setInitialDt().

◆ d_initial_time

double AMP::TimeIntegrator::TimeIntegrator::d_initial_time = std::numeric_limits<double>::signaling_NaN()

protectedinherited

Definition at line 344 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::TimeIntegrator::setInitialTime().

◆ d_initialized

bool AMP::TimeIntegrator::TimeIntegrator::d_initialized = false

protectedinherited

Set to true after initialization in constructors. Needed in getFromInput to avoid reseting some parameters in subsequent reset operations.

Definition at line 370 of file TimeIntegrator.h.

◆ d_integrator_step

int AMP::TimeIntegrator::TimeIntegrator::d_integrator_step = 0

protectedinherited

Definition at line 358 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::ImplicitIntegrator::stepsRemaining().

◆ d_linear_solver_type

int AMP::TimeIntegrator::IDATimeIntegrator::d_linear_solver_type

private

Definition at line 262 of file IDATimeIntegrator.h.

◆ d_max_dt

double AMP::TimeIntegrator::TimeIntegrator::d_max_dt = std::numeric_limits<double>::max()

protectedinherited

maximum allowable timestep (user defined)

Definition at line 355 of file TimeIntegrator.h.

◆ d_max_integrator_steps

int AMP::TimeIntegrator::TimeIntegrator::d_max_integrator_steps = 0

protectedinherited

Definition at line 359 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::ImplicitIntegrator::stepsRemaining().

◆ d_min_dt

double AMP::TimeIntegrator::TimeIntegrator::d_min_dt = std::numeric_limits<double>::signaling_NaN()

protectedinherited

Definition at line 352 of file TimeIntegrator.h.

◆ d_object_name

std::string AMP::TimeIntegrator::TimeIntegrator::d_object_name

protectedinherited

Definition at line 305 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::ImplicitIntegrator::getObjectName().

◆ d_old_dt

double AMP::TimeIntegrator::TimeIntegrator::d_old_dt = std::numeric_limits<double>::signaling_NaN()

protectedinherited

Definition at line 351 of file TimeIntegrator.h.

◆ d_operator

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

protectedinherited

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 328 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::TimeIntegrator::getOperator(), and AMP::TimeIntegrator::TimeIntegrator::registerOperator().

◆ d_pIDATimeOperator

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

private

Definition at line 277 of file IDATimeIntegrator.h.

◆ d_pLinearTimeOperator

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

private

Definition at line 278 of file IDATimeIntegrator.h.

◆ d_pMassOperator

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

protectedinherited

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

Definition at line 333 of file TimeIntegrator.h.

◆ d_pNestedSolver

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

private

Definition at line 281 of file IDATimeIntegrator.h.

Referenced by getPreconditioner().

◆ d_pParameters

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

protectedinherited

pointer to parameters

Definition at line 310 of file TimeIntegrator.h.

◆ d_pSourceTerm

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

protectedinherited

Definition at line 338 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::TimeIntegrator::getSourceTerm(), and AMP::TimeIntegrator::TimeIntegrator::setSourceTerm().

◆ d_relative_tolerance

double AMP::TimeIntegrator::IDATimeIntegrator::d_relative_tolerance

private

Definition at line 259 of file IDATimeIntegrator.h.

◆ d_residual

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::TimeIntegrator::IDATimeIntegrator::d_residual

not sure why this variable exists and is public, BP

Definition at line 213 of file IDATimeIntegrator.h.

◆ d_solution_prime

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::TimeIntegrator::IDATimeIntegrator::d_solution_prime

private

Definition at line 279 of file IDATimeIntegrator.h.

◆ d_solution_vector

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::TimeIntegrator::TimeIntegrator::d_solution_vector

protectedinherited

Definition at line 320 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::TimeIntegrator::getSolution().

◆ d_total_steprejects

int AMP::TimeIntegrator::TimeIntegrator::d_total_steprejects = 0

protectedinherited

Definition at line 361 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::BDFIntegrator::getNumberOfStepRejections(), and AMP::TimeIntegrator::TimeIntegrator::getTotalRejectedSteps().

◆ d_writer

std::shared_ptr<AMP::IO::Writer> AMP::TimeIntegrator::TimeIntegrator::d_writer

protectedinherited

keeps track of total number of step rejections

Definition at line 364 of file TimeIntegrator.h.

Referenced by AMP::TimeIntegrator::TimeIntegrator::registerWriter().

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

src/time_integrators/sundials/IDATimeIntegrator.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ shared_ptr

Constructor & Destructor Documentation

◆ IDATimeIntegrator() [1/2]

◆ ~IDATimeIntegrator()

◆ IDATimeIntegrator() [2/2]

Member Function Documentation

◆ advanceSolution()

◆ appendRhsVector()

◆ appendSolutionVector()

◆ checkNewSolution()

◆ getBoolManufacturedProblem()

◆ getCurrentDt()

◆ getCurrentTime()

◆ getFinalTime()

◆ getFromInput()

◆ getFromRestart()

◆ getGamma()

◆ getID()

◆ getIDAMem()

◆ getIDATimeOperator()

◆ getInitialDt()

◆ getInitialTime()

◆ getIntegratorStep()

◆ getLinearTimeOperator()

◆ getMaxIntegratorSteps()

◆ getNextDt()

◆ getOperator()

◆ getPreconditioner()

◆ getResidualVector()

◆ getSolution()

◆ getSourceTerm()

◆ getTimeHistoryScalings()

◆ getTotalRejectedSteps()

◆ IDAPrecSetup()

◆ IDAPrecSolve()

◆ IDAResTrial()

◆ initialize()

◆ initializeIDA()

◆ printClassData()

◆ printStatistics()

◆ putToDatabase()

◆ registerChildObjects()

◆ registerOperator()

◆ registerWriter()

◆ reset()

◆ setCurrentDt()

◆ setCurrentTime()

◆ setFinalTime()

◆ setInitialDt()

◆ setInitialGuess()

◆ setInitialTime()

◆ setSourceTerm()

◆ setupVectors()

◆ sizeOfTimeHistory()

◆ stepsRemaining()

◆ type()

◆ updateSolution()

◆ updateSourceTerm()

◆ writeRestart()

Member Data Documentation

◆ d_absolute_tolerance

◆ d_bCallCalcIC

◆ d_bLinearMassOperator

◆ d_bLinearRhsOperator

◆ d_bManufacturedProblem

◆ d_bUsePreconditioner

◆ d_createLinearOperatorInternally

◆ d_current_dt

◆ d_current_time

◆ d_final_time