data structure for TS (time stepping) context More...

#include <src/interfaces/LoopMethods.hpp>

Inheritance diagram for MoFEM::TSMethod:

Collaboration diagram for MoFEM::TSMethod:

Public Types
enum	TSContext { CTX_TSSETRHSFUNCTION , CTX_TSSETRHSJACOBIAN , CTX_TSSETIFUNCTION , CTX_TSSETIJACOBIAN , CTX_TSTSMONITORSET , CTX_TSNONE }

Public Member Functions
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	TSMethod ()

virtual	~TSMethod ()=default

MoFEMErrorCode	copyTs (const TSMethod &ts)
	Copy TS solver data. More...

Public Attributes
TS	ts
	time solver More...

TSContext	ts_ctx

PetscInt	ts_step
	time step number More...

PetscReal	ts_a
	shift for U_t (see PETSc Time Solver) More...

PetscReal	ts_aa
	shift for U_tt shift for U_tt More...

PetscReal	ts_t
	time More...

PetscReal	ts_dt
	time step size More...

Vec &	ts_u
	state vector More...

Vec &	ts_u_t
	time derivative of state vector More...

Vec &	ts_u_tt
	second time derivative of state vector More...

Vec &	ts_F
	residual vector More...

Mat &	ts_A

Mat &	ts_B
	Preconditioner for ts_A. More...

Additional Inherited Members
Protected Types inherited from MoFEM::PetscData
enum	DataContext { CTX_SET_NONE = 0 , CTX_SET_F = 1 << 0 , CTX_SET_A = 1 << 1 , CTX_SET_B = 1 << 2 , CTX_SET_X = 1 << 3 , CTX_SET_X_T = 1 << 4 , CTX_SET_X_TT = 1 << 6 , CTX_SET_TIME = 1 << 7 }

using	Switches = std::bitset< 8 >

Protected Member Functions inherited from MoFEM::PetscData
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	PetscData ()

virtual	~PetscData ()=default

MoFEMErrorCode	copyPetscData (const PetscData &petsc_data)

Protected Member Functions inherited from MoFEM::UnknownInterface
virtual MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const =0

template<class IFACE >
MoFEMErrorCode	registerInterface (bool error_if_registration_failed=true)
	Register interface. More...

template<class IFACE >
MoFEMErrorCode	getInterface (IFACE *&iface) const
	Get interface refernce to pointer of interface. More...

template<class IFACE >
MoFEMErrorCode	getInterface (IFACE **const iface) const
	Get interface pointer to pointer of interface. More...

template<class IFACE , typename boost::enable_if< boost::is_pointer< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get interface pointer to pointer of interface. More...

template<class IFACE , typename boost::enable_if< boost::is_reference< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get reference to interface. More...

template<class IFACE >
IFACE *	getInterface () const
	Function returning pointer to interface. More...

virtual	~UnknownInterface ()=default

Static Protected Member Functions inherited from MoFEM::UnknownInterface
static MoFEMErrorCode	getLibVersion (Version &version)
	Get library version. More...

static MoFEMErrorCode	getFileVersion (moab::Interface &moab, Version &version)
	Get database major version. More...

static MoFEMErrorCode	setFileVersion (moab::Interface &moab, Version version=Version(MoFEM_VERSION_MAJOR, MoFEM_VERSION_MINOR, MoFEM_VERSION_BUILD))
	Get database major version. More...

static MoFEMErrorCode	getInterfaceVersion (Version &version)
	Get database major version. More...

Protected Attributes inherited from MoFEM::PetscData
Switches	data_ctx

Vec	f

Mat	A

Mat	B

Vec	x

Vec	x_t

Vec	x_tt

Static Protected Attributes inherited from MoFEM::PetscData
static constexpr Switches	CtxSetNone = PetscData::Switches(CTX_SET_NONE)

static constexpr Switches	CtxSetF = PetscData::Switches(CTX_SET_F)

static constexpr Switches	CtxSetA = PetscData::Switches(CTX_SET_A)

static constexpr Switches	CtxSetB = PetscData::Switches(CTX_SET_B)

static constexpr Switches	CtxSetX = PetscData::Switches(CTX_SET_X)

static constexpr Switches	CtxSetX_T = PetscData::Switches(CTX_SET_X_T)

static constexpr Switches	CtxSetX_TT = PetscData::Switches(CTX_SET_X_TT)

static constexpr Switches	CtxSetTime = PetscData::Switches(CTX_SET_TIME)

Detailed Description

data structure for TS (time stepping) context

Structure stores context data which are set in functions run by PETSc Time Stepping functions.

Definition at line 134 of file LoopMethods.hpp.

Member Enumeration Documentation

◆ TSContext

enum MoFEM::TSMethod::TSContext

Enumerator
CTX_TSSETRHSFUNCTION
CTX_TSSETRHSJACOBIAN
CTX_TSSETIFUNCTION
CTX_TSSETIJACOBIAN
CTX_TSTSMONITORSET
CTX_TSNONE

Definition at line 139 of file LoopMethods.hpp.

                 {
    CTX_TSSETRHSFUNCTION,
    CTX_TSSETRHSJACOBIAN,
    CTX_TSSETIFUNCTION,
    CTX_TSSETIJACOBIAN,
    CTX_TSTSMONITORSET,
    CTX_TSNONE
  };

Constructor & Destructor Documentation

◆ TSMethod()

MoFEM::TSMethod::TSMethod ( )

Definition at line 91 of file LoopMethods.cpp.

    : ts_ctx(CTX_TSNONE), ts_step(-1), ts_a(0), ts_t(0), ts_u(PetscData::x),
      ts_u_t(PetscData::x_t), ts_u_tt(PetscData::x_tt), ts_F(PetscData::f),
      ts_A(PetscData::A), ts_B(PetscData::B) {}

◆ ~TSMethod()

virtual MoFEM::TSMethod::~TSMethod ( )

virtualdefault

Member Function Documentation

◆ copyTs()

MoFEMErrorCode MoFEM::TSMethod::copyTs ( const TSMethod & ts )

Copy TS solver data.

Definition at line 96 of file LoopMethods.cpp.

                                                  {
  MoFEMFunctionBeginHot;
  CHKERR copyPetscData(ts);
  this->ts_ctx = ts.ts_ctx;
  this->ts = ts.ts;
  this->ts_step = ts.ts_step;
  this->ts_a = ts.ts_a;
  this->ts_t = ts.ts_t;
  this->ts_dt = ts.ts_dt;
  MoFEMFunctionReturnHot(0);
}

◆ query_interface()

MoFEMErrorCode MoFEM::TSMethod::query_interface	(	boost::typeindex::type_index	type_index,
		UnknownInterface **	iface
	)		const

virtual

Reimplemented from MoFEM::PetscData.

Reimplemented in MoFEM::BasicMethod, MoFEM::FEMethod, MoFEM::EntityMethod, and MoFEM::DofMethod.

Definition at line 85 of file LoopMethods.cpp.

                                                          {
  *iface = const_cast<TSMethod *>(this);
  return 0;
}

Member Data Documentation

◆ ts

TS MoFEM::TSMethod::ts

time solver

Examples: UnsaturatedFlow.hpp, and nonlinear_dynamics.cpp.

Definition at line 155 of file LoopMethods.hpp.

◆ ts_a

PetscReal MoFEM::TSMethod::ts_a

shift for U_t (see PETSc Time Solver)

Examples: UnsaturatedFlow.hpp, and reaction_diffusion.cpp.

Definition at line 160 of file LoopMethods.hpp.

◆ ts_A

Mat& MoFEM::TSMethod::ts_A

Jacobian of G(U) = F(t,U,W+v*U,W'+a*U), equivalent to dF/dU + v*dF/dU_t + a*dF/dU_tt

Definition at line 170 of file LoopMethods.hpp.

◆ ts_aa

PetscReal MoFEM::TSMethod::ts_aa

shift for U_tt shift for U_tt

Definition at line 161 of file LoopMethods.hpp.

◆ ts_B

Mat& MoFEM::TSMethod::ts_B

Preconditioner for ts_A.

Examples: UnsaturatedFlow.hpp.

Definition at line 172 of file LoopMethods.hpp.

◆ ts_ctx

TSContext MoFEM::TSMethod::ts_ctx

Examples: nonlinear_dynamics.cpp.

Definition at line 157 of file LoopMethods.hpp.

◆ ts_dt

PetscReal MoFEM::TSMethod::ts_dt

time step size

Definition at line 163 of file LoopMethods.hpp.

◆ ts_F

Vec& MoFEM::TSMethod::ts_F

residual vector

Examples: UnsaturatedFlow.hpp.

Definition at line 168 of file LoopMethods.hpp.

◆ ts_step

PetscInt MoFEM::TSMethod::ts_step

time step number

Examples: free_surface.cpp, heat_equation.cpp, nonlinear_dynamics.cpp, nonlinear_elastic.cpp, photon_diffusion.cpp, reaction_diffusion.cpp, shallow_wave.cpp, and wave_equation.cpp.

Definition at line 159 of file LoopMethods.hpp.

◆ ts_t

PetscReal MoFEM::TSMethod::ts_t

time

Examples: UnsaturatedFlow.hpp, free_surface.cpp, and nonlinear_dynamics.cpp.

Definition at line 162 of file LoopMethods.hpp.

◆ ts_u

Vec& MoFEM::TSMethod::ts_u

state vector

Examples: shallow_wave.cpp.

Definition at line 165 of file LoopMethods.hpp.

◆ ts_u_t

Vec& MoFEM::TSMethod::ts_u_t

time derivative of state vector

Definition at line 166 of file LoopMethods.hpp.

◆ ts_u_tt

Vec& MoFEM::TSMethod::ts_u_tt

second time derivative of state vector

Definition at line 167 of file LoopMethods.hpp.

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

src/interfaces/LoopMethods.hpp
src/interfaces/impl/LoopMethods.cpp

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members