OperatorBase< number > Class Template Reference

Developer Documentation: MeltPoolDG::OperatorBase< number > Class Template Reference
Developer Documentation
MeltPoolDG::OperatorBase< number > Class Template Reference

#include <operator_base.hpp>

Inheritance diagram for MeltPoolDG::OperatorBase< number >:
[legend]

Public Member Functions

virtual ~OperatorBase ()=default
 
void reset_dof_index (const unsigned int dof_idx_in)
 Set the index for the current degrees of freedom (DoF).
 
void reset_time_increment (const number dt)
 Set the time increment for the operator.
 
virtual void pre ()
 Prepare for computations (e.g. update ghost values). Can be overridden by derived classes.
 
virtual void post ()
 Finalize for computations (e.g. zero out ghost values). Can be overridden by derived classes.
 
virtual void reinit ()
 Reinitialize data structures. Can be overridden by derived classes.
 

Protected Attributes

unsigned int dof_idx = dealii::numbers::invalid_unsigned_int
 
number time_increment = numbers::invalid_double
 
number time_increment_inv = numbers::invalid_double
 

Constructor & Destructor Documentation

◆ ~OperatorBase()

template<typename number >
virtual MeltPoolDG::OperatorBase< number >::~OperatorBase ( )
virtualdefault

Member Function Documentation

◆ post()

template<typename number >
virtual void MeltPoolDG::OperatorBase< number >::post ( )
inlinevirtual

Finalize for computations (e.g. zero out ghost values). Can be overridden by derived classes.

Reimplemented in MeltPoolDG::Heat::HeatDiffuseMultiPhaseOperator< dim, number >, and MeltPoolDG::LevelSet::AdvectionDiffusionOperator< dim, number >.

◆ pre()

template<typename number >
virtual void MeltPoolDG::OperatorBase< number >::pre ( )
inlinevirtual

Prepare for computations (e.g. update ghost values). Can be overridden by derived classes.

Reimplemented in MeltPoolDG::Heat::HeatDiffuseMultiPhaseOperator< dim, number >, and MeltPoolDG::LevelSet::AdvectionDiffusionOperator< dim, number >.

◆ reinit()

◆ reset_dof_index()

template<typename number >
void MeltPoolDG::OperatorBase< number >::reset_dof_index ( const unsigned int  dof_idx_in)
inline

Set the index for the current degrees of freedom (DoF).

Parameters
dof_idx_inThe index of the DoF.

◆ reset_time_increment()

template<typename number >
void MeltPoolDG::OperatorBase< number >::reset_time_increment ( const number  dt)
inline

Set the time increment for the operator.

Parameters
dtTime increment value.

Member Data Documentation

◆ dof_idx

template<typename number >
unsigned int MeltPoolDG::OperatorBase< number >::dof_idx = dealii::numbers::invalid_unsigned_int
protected

◆ time_increment

template<typename number >
number MeltPoolDG::OperatorBase< number >::time_increment = numbers::invalid_double
protected

◆ time_increment_inv

template<typename number >
number MeltPoolDG::OperatorBase< number >::time_increment_inv = numbers::invalid_double
protected

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