mfem::GeneralizedAlphaSolver Class Reference

#include <ode.hpp>

Inheritance diagram for mfem::GeneralizedAlphaSolver:

Collaboration diagram for mfem::GeneralizedAlphaSolver:

Public Member Functions
	GeneralizedAlphaSolver (double rho=1.0)
virtual void	Init (TimeDependentOperator &_f)
	Associate a TimeDependentOperator with the ODE solver. More...
virtual void	Step (Vector &x, double &t, double &dt)
	Perform a time step from time t [in] to time t [out] based on the requested step size dt [in]. More...
Public Member Functions inherited from mfem::ODESolver
	ODESolver ()
virtual void	Run (Vector &x, double &t, double &dt, double tf)
	Perform time integration from time t [in] to time tf [in]. More...
virtual	~ODESolver ()

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

Protected Attributes
Vector	xdot
Vector	k
Vector	y
double	alpha_f
double	alpha_m
double	gamma
bool	first
Protected Attributes inherited from mfem::ODESolver
TimeDependentOperator *	f
	Pointer to the associated TimeDependentOperator. More...
MemoryType	mem_type

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 437 of file ode.hpp.

Constructor & Destructor Documentation

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

inline

Definition at line 448 of file ode.hpp.

Member Function Documentation

void mfem::GeneralizedAlphaSolver::Init ( TimeDependentOperator &  f )

virtual

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 637 of file ode.cpp.

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

protected

Definition at line 658 of file ode.cpp.

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

protected

Definition at line 647 of file ode.cpp.

void mfem::GeneralizedAlphaSolver::Step ( Vector &  x, double &  t, double &  dt  )

virtual

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 685 of file ode.cpp.

Member Data Documentation

double mfem::GeneralizedAlphaSolver::alpha_f

protected

Definition at line 441 of file ode.hpp.

double mfem::GeneralizedAlphaSolver::alpha_m

protected

Definition at line 441 of file ode.hpp.

bool mfem::GeneralizedAlphaSolver::first

protected

Definition at line 442 of file ode.hpp.

double mfem::GeneralizedAlphaSolver::gamma

protected

Definition at line 441 of file ode.hpp.

Vector mfem::GeneralizedAlphaSolver::k

mutableprotected

Definition at line 440 of file ode.hpp.

Vector mfem::GeneralizedAlphaSolver::xdot

mutableprotected

Definition at line 440 of file ode.hpp.

Vector mfem::GeneralizedAlphaSolver::y

mutableprotected

Definition at line 440 of file ode.hpp.

---

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

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