PDEOperatorBase< dim, degree, number > Class Template Reference

This class contains the user implementation of each PDE operator. More...

#include <pde_operator_base.h>

Public Types
using	SizeType = dealii::VectorizedArray< number >

Public Member Functions
	PDEOperatorBase (const UserInputParameters< dim > &_user_inputs, const PhaseFieldTools< dim > &_pf_tools)
	Constructor.
virtual	~PDEOperatorBase ()=default
	Destructor.
virtual void	set_initial_condition (const unsigned int &index, const unsigned int &component, const dealii::Point< dim > &point, number &scalar_value, number &vector_component_value) const
	User-implemented class for the setting initial conditions.
virtual void	set_nonuniform_dirichlet (const unsigned int &index, const unsigned int &boundary_id, const unsigned int &component, const dealii::Point< dim > &point, number &scalar_value, number &vector_component_value) const
	User-implemented class for the setting nonuniform boundary conditions. Default behavior is to call initial conditions.
virtual void	compute_rhs (FieldContainer< dim, degree, number > &variable_list, const SimulationTimer &sim_timer, unsigned int solver_id) const
	User-implemented class for the RHS of explicit equations.
virtual void	compute_lhs (FieldContainer< dim, degree, number > &variable_list, const SimulationTimer &sim_timer, unsigned int solver_id) const
	User-implemented class for the RHS of nonexplicit equations.
const UserInputParameters< dim > &	get_user_inputs () const
	Get the user inputs (constant reference).
const PhaseFieldTools< dim > &	get_pf_tools () const
	Get the phase field tools (constant reference).

Private Attributes
const UserInputParameters< dim > *	user_inputs = nullptr
	The user-inputs.
const PhaseFieldTools< dim > *	pf_tools = nullptr
	Phase field tools.

Detailed Description

template<unsigned int dim, unsigned int degree, typename number>
class PDEOperatorBase< dim, degree, number >

This class contains the user implementation of each PDE operator.

Member Typedef Documentation

SizeType

template<unsigned int dim, unsigned int degree, typename number >

using PDEOperatorBase< dim, degree, number >::SizeType = dealii::VectorizedArray<number>

Constructor & Destructor Documentation

PDEOperatorBase()

template<unsigned int dim, unsigned int degree, typename number >

PDEOperatorBase< dim, degree, number >::PDEOperatorBase ( const UserInputParameters< dim > &  _user_inputs, const PhaseFieldTools< dim > &  _pf_tools  )

inlineexplicit

Constructor.

~PDEOperatorBase()

template<unsigned int dim, unsigned int degree, typename number >

virtual PDEOperatorBase< dim, degree, number >::~PDEOperatorBase ( )

virtualdefault

Destructor.

Member Function Documentation

compute_lhs()

template<unsigned int dim, unsigned int degree, typename number >

virtual void PDEOperatorBase< dim, degree, number >::compute_lhs ( FieldContainer< dim, degree, number > &  variable_list, const SimulationTimer &  sim_timer, unsigned int  solver_id  ) const

inlinevirtual

User-implemented class for the RHS of nonexplicit equations.

compute_rhs()

template<unsigned int dim, unsigned int degree, typename number >

virtual void PDEOperatorBase< dim, degree, number >::compute_rhs ( FieldContainer< dim, degree, number > &  variable_list, const SimulationTimer &  sim_timer, unsigned int  solver_id  ) const

inlinevirtual

User-implemented class for the RHS of explicit equations.

get_pf_tools()

template<unsigned int dim, unsigned int degree, typename number >

const PhaseFieldTools< dim > & PDEOperatorBase< dim, degree, number >::get_pf_tools ( ) const

inline

Get the phase field tools (constant reference).

get_user_inputs()

template<unsigned int dim, unsigned int degree, typename number >

const UserInputParameters< dim > & PDEOperatorBase< dim, degree, number >::get_user_inputs ( ) const

inline

Get the user inputs (constant reference).

set_initial_condition()

template<unsigned int dim, unsigned int degree, typename number >

virtual void PDEOperatorBase< dim, degree, number >::set_initial_condition ( const unsigned int &  index, const unsigned int &  component, const dealii::Point< dim > &  point, number &  scalar_value, number &  vector_component_value  ) const

inlinevirtual

User-implemented class for the setting initial conditions.

set_nonuniform_dirichlet()

template<unsigned int dim, unsigned int degree, typename number >

virtual void PDEOperatorBase< dim, degree, number >::set_nonuniform_dirichlet ( const unsigned int &  index, const unsigned int &  boundary_id, const unsigned int &  component, const dealii::Point< dim > &  point, number &  scalar_value, number &  vector_component_value  ) const

inlinevirtual

User-implemented class for the setting nonuniform boundary conditions. Default behavior is to call initial conditions.

Member Data Documentation

pf_tools

template<unsigned int dim, unsigned int degree, typename number >

const PhaseFieldTools<dim>* PDEOperatorBase< dim, degree, number >::pf_tools = nullptr

private

Phase field tools.

user_inputs

template<unsigned int dim, unsigned int degree, typename number >

const UserInputParameters<dim>* PDEOperatorBase< dim, degree, number >::user_inputs = nullptr

private

The user-inputs.

---

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

• /home/runner/work/phaseField/phaseField/include/prismspf/core/constraint_manager.h
• /home/runner/work/phaseField/phaseField/include/prismspf/core/pde_operator_base.h