mfem::AdamsMoultonSolver Class Reference

#include <ode.hpp>

Inheritance diagram for mfem::AdamsMoultonSolver:

Collaboration diagram for mfem::AdamsMoultonSolver:

Public Member Functions
	AdamsMoultonSolver (int s_, const real_t *a_)
void	Init (TimeDependentOperator &f_) override
	Associate a TimeDependentOperator with the ODE solver.
void	Step (Vector &x, real_t &t, real_t &dt) override
	Perform a time step from time t [in] to time t [out] based on the requested step size dt [in].
ODEStateData &	GetState () override
	Returns the StateData.
const ODEStateData &	GetState () const override
	Returns the StateData.
bool	SupportsImplicitVariableType (ImplicitVariableType var) const override
	Returns true if the ODESolver supports the given ImplicitVariableType, var, and returns false otherwise. Default implementation returns true if var is ImplicitVariableType::SLOPE and false otherwise.
Public Member Functions inherited from mfem::ODESolverWithStates
virtual int	GetStateSize ()
	Returns how many State vectors the ODE requires.
Public Member Functions inherited from mfem::ODESolver
	ODESolver ()
virtual void	Run (Vector &x, real_t &t, real_t &dt, real_t tf)
	Perform time integration from time t [in] to time tf [in].
void	SetImplicitVariableType (const ImplicitVariableType variable_type)
	Sets the ImplicitVariableType for the TimeDependentOperator, if supported.
virtual void	ComputeSlopeFromState (const real_t dt, const Vector &u, Vector &k)
	Compute the finite-difference slope, \(\frac{du}{dt} \approx \frac{u(t+dt)-u(t)}{dt}\), and store it in k.
virtual	~ODESolver ()

Protected Member Functions
bool	print ()
void	CheckTimestep (real_t dt)

Protected Attributes
std::unique_ptr< ODESolver >	RKsolver
Protected Attributes inherited from mfem::ODESolver
TimeDependentOperator *	f
	Pointer to the associated TimeDependentOperator.
MemoryType	mem_type

Additional Inherited Members
Static Public Member Functions inherited from mfem::ODESolver
static MFEM_EXPORT std::unique_ptr< ODESolver >	Select (const int ode_solver_type)
static MFEM_EXPORT std::unique_ptr< ODESolver >	SelectExplicit (const int ode_solver_type)
static MFEM_EXPORT std::unique_ptr< ODESolver >	SelectImplicit (const int ode_solver_type)
static MFEM_EXPORT std::unique_ptr< ODESolver >	SelectIMEX (const int ode_solver_type)
Static Public Attributes inherited from mfem::ODESolver
static MFEM_EXPORT std::string	ExplicitTypes
static MFEM_EXPORT std::string	ImplicitTypes
static MFEM_EXPORT std::string	IMEXTypes
static MFEM_EXPORT std::string	Types
Protected Types inherited from mfem::ODESolver
using	ImplicitVariableType = TimeDependentOperator::ImplicitVariableType

Detailed Description

An implicit Adams-Moulton method.

Definition at line 670 of file ode.hpp.

Constructor & Destructor Documentation

AdamsMoultonSolver()

mfem::AdamsMoultonSolver::AdamsMoultonSolver	(	int	s_,
		const real_t *	a_ )

Definition at line 607 of file ode.cpp.

Member Function Documentation

CheckTimestep()

void mfem::AdamsMoultonSolver::CheckTimestep ( real_t dt )

protected

GetState() [1/2]

const ODEStateData & mfem::AdamsMoultonSolver::GetState ( ) const

inlineoverridevirtual

Returns the StateData.

Implements mfem::ODESolverWithStates.

Definition at line 698 of file ode.hpp.

GetState() [2/2]

ODEStateData & mfem::AdamsMoultonSolver::GetState ( )

inlineoverridevirtual

Returns the StateData.

Implements mfem::ODESolverWithStates.

Definition at line 697 of file ode.hpp.

Init()

void mfem::AdamsMoultonSolver::Init ( TimeDependentOperator & f_ )

overridevirtual

Associate a TimeDependentOperator with the ODE solver.

This method has to be called:

• Before the first call to Step().
• When the dimensions of the associated TimeDependentOperator change.
• When a time stepping sequence has to be restarted.
• To change the associated TimeDependentOperator.

Reimplemented from mfem::ODESolver.

Definition at line 613 of file ode.cpp.

print()

bool mfem::AdamsMoultonSolver::print ( )

inlineprotected

Definition at line 681 of file ode.hpp.

Step()

void mfem::AdamsMoultonSolver::Step ( Vector & x, real_t & t, real_t & dt )

overridevirtual

Perform a time step from time t [in] to time t [out] based on the requested step size dt [in].

Parameters

[in,out]	x	Approximate solution.
[in,out]	t	Time associated with the approximate solution x.
[in,out]	dt	Time step size.

The following rules describe the common behavior of the method:

• The input x [in] is the approximate solution for the input time t [in].
• The input dt [in] is the desired time step size, defining the desired target time: t [target] = t [in] + dt [in].
• The output x [out] is the approximate solution for the output time t [out].
• The output dt [out] is the last time step taken by the method which may be smaller or larger than the input dt [in] value, e.g. because of time step control.
• The method may perform more than one time step internally; in this case dt [out] is the last internal time step size.
• The output value of t [out] may be smaller or larger than t [target], however, it is not smaller than t [in] + dt [out], if at least one internal time step was performed.
• The value x [out] may be obtained by interpolation using internally stored data.
• In some cases, the contents of x [in] may not be used, e.g. when x [out] from a previous Step() call was obtained by interpolation.
• In consecutive calls to this method, the output t [out] of one Step() call has to be the same as the input t [in] to the next Step() call.
• If the previous rule has to be broken, e.g. to restart a time stepping sequence, then the ODE solver must be re-initialized by calling Init() between the two Step() calls.

Implements mfem::ODESolver.

Definition at line 621 of file ode.cpp.

SupportsImplicitVariableType()

bool mfem::AdamsMoultonSolver::SupportsImplicitVariableType ( ImplicitVariableType var ) const

inlineoverridevirtual

Returns true if the ODESolver supports the given ImplicitVariableType, var, and returns false otherwise. Default implementation returns true if var is ImplicitVariableType::SLOPE and false otherwise.

Warning

Should be overridden in ODESolver that calls TimeDependentOperator::ImplicitSolve().

Reimplemented from mfem::ODESolver.

Definition at line 699 of file ode.hpp.

Member Data Documentation

RKsolver

std::unique_ptr<ODESolver> mfem::AdamsMoultonSolver::RKsolver

protected

Definition at line 679 of file ode.hpp.

---

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

• linalg/ode.hpp
• linalg/ode.cpp