mfem::GeneralizedAlphaSolver Class Reference

#include <ode.hpp>

Inheritance diagram for mfem::GeneralizedAlphaSolver:

Collaboration diagram for mfem::GeneralizedAlphaSolver:

Public Member Functions
	GeneralizedAlphaSolver (real_t rho=1.0)
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.
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].
virtual	~ODESolver ()

Protected Member Functions
void	SetRhoInf (real_t rho_inf)
void	PrintProperties (std::ostream &os=mfem::out)

Protected Attributes
Vector	k
Vector	y
real_t	alpha_f
real_t	alpha_m
real_t	gamma
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 Public Attributes inherited from mfem::ODESolver
static MFEM_EXPORT std::string	ExplicitTypes
static MFEM_EXPORT std::string	ImplicitTypes
static MFEM_EXPORT std::string	Types

Detailed Description

Generalized-alpha ODE solver from "A generalized-α method for integrating the filtered Navier-Stokes equations with a stabilized finite element method" by K.E. Jansen, C.H. Whiting and G.M. Hulbert.

Definition at line 455 of file ode.hpp.

Constructor & Destructor Documentation

GeneralizedAlphaSolver()

mfem::GeneralizedAlphaSolver::GeneralizedAlphaSolver ( real_t rho = 1.0 )

inline

Definition at line 468 of file ode.hpp.

Member Function Documentation

GetState() [1/2]

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

inlineoverridevirtual

Returns the StateData.

Implements mfem::ODESolverWithStates.

Definition at line 473 of file ode.hpp.

GetState() [2/2]

ODEStateData & mfem::GeneralizedAlphaSolver::GetState ( )

inlineoverridevirtual

Returns the StateData.

Implements mfem::ODESolverWithStates.

Definition at line 472 of file ode.hpp.

Init()

void mfem::GeneralizedAlphaSolver::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 877 of file ode.cpp.

PrintProperties()

void mfem::GeneralizedAlphaSolver::PrintProperties ( std::ostream & os = mfem::out )

protected

Definition at line 896 of file ode.cpp.

SetRhoInf()

void mfem::GeneralizedAlphaSolver::SetRhoInf ( real_t rho_inf )

protected

Definition at line 885 of file ode.cpp.

Step()

void mfem::GeneralizedAlphaSolver::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 923 of file ode.cpp.

Member Data Documentation

alpha_f

real_t mfem::GeneralizedAlphaSolver::alpha_f

protected

Definition at line 462 of file ode.hpp.

alpha_m

real_t mfem::GeneralizedAlphaSolver::alpha_m

protected

Definition at line 462 of file ode.hpp.

gamma

real_t mfem::GeneralizedAlphaSolver::gamma

protected

Definition at line 462 of file ode.hpp.

k

Vector mfem::GeneralizedAlphaSolver::k

mutableprotected

Definition at line 461 of file ode.hpp.

y

Vector mfem::GeneralizedAlphaSolver::y

protected

Definition at line 461 of file ode.hpp.

---

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

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