ConstraintManager< dim, degree, number > Class Template Reference

The class handles the generation and application of boundary conditions based on the user-inputs. More...

#include <constraint_manager.h>

Collaboration diagram for ConstraintManager< dim, degree, number >:

Public Member Functions
	ConstraintManager ()=default
	Constructor.
void	init (const BoundaryParameters &_boundary_parameters, const SpatialDiscretization< dim > &_spatial_discretization, const DoFManager< dim, degree > &_dof_manager, const PDEOperatorBase< dim, degree, number > &_pde_operator, const SimulationTimer &_sim_timer)
	Initialize the constraint manager.
std::vector< const dealii::AffineConstraints< number > * >	get_field_constraints () const
	Getter function for the constraints.
const dealii::AffineConstraints< number > &	get_field_constraint (Types::Index index) const
	Getter function for the constraint of an index.
const std::array< dealii::AffineConstraints< number >, 2 > &	get_generic_constraints () const
	Getter function for the constraints.
const dealii::AffineConstraints< number > &	get_generic_constraint (unsigned int rank) const
	Getter function for the constraint of an index.
const std::vector< std::vector< dealii::AffineConstraints< number > > > &	get_mg_field_constraints_levels () const
	Getter function for a selection of the constraints.
std::vector< const dealii::AffineConstraints< number > * >	get_mg_field_constraints (unsigned int relative_level) const
	Getter function for the constraints.
const dealii::AffineConstraints< number > &	get_mg_field_constraint (Types::Index index, unsigned int relative_level) const
	Getter function for the constraint of an index (constant reference).
const std::vector< std::array< dealii::AffineConstraints< number >, 2 > > &	get_mg_generic_constraints_levels () const
	Getter function for the constraints.
const std::array< dealii::AffineConstraints< number >, 2 > &	get_mg_generic_constraints (unsigned int relative_level) const
	Getter function for the constraints.
const dealii::AffineConstraints< number > &	get_mg_generic_constraint (unsigned int rank, unsigned int relative_level) const
	Getter function for the constraint of an index (constant reference).
void	reinit (const std::vector< FieldAttributes > &field_attributes)
	Make constraints based on the inputs of the constructor.
void	update_time_dependent_constraints (const std::vector< FieldAttributes > &field_attributes)
	Update time-dependent constraints. For now this only updates the Dirichlet constraints.

Static Public Attributes
static const std::array< dealii::ComponentMask, dim >	vector_component_mask
	Create a component mask.
static const dealii::ComponentMask	scalar_empty_mask

Private Member Functions
void	make_constraints_for_single_field (dealii::AffineConstraints< number > &constraint, const dealii::DoFHandler< dim > &dof_handler, const BoundaryConditionSet &_field_constraints, TensorRank tensor_rank, Types::Index field_index, unsigned int relative_level=-1)
	Construct constraints for a single field based on the boundary conditions.
void	make_bc_constraints (dealii::AffineConstraints< number > &constraint, const dealii::DoFHandler< dim > &dof_handler, const BoundaryConditionSet &boundary_condition, TensorRank tensor_rank, Types::Index field_index)
	Add boundary conditions to a single constraint.
void	make_one_boundary_constraint (dealii::AffineConstraints< number > &_constraints, unsigned int boundary_id, unsigned int component, Condition boundary_type, const dealii::DoFHandler< dim > &dof_handler, TensorRank tensor_rank, Types::Index field_index) const
	Apply constraints for common boundary conditions.
void	make_dirichlet_constraints (dealii::AffineConstraints< number > &_constraints, const dealii::DoFHandler< dim > &dof_handler, const unsigned int &boundary_id, const unsigned int &field_index, const bool &is_vector_field, const dealii::ComponentMask &mask) const
	Make dirichlet constraints.

Private Attributes
const BoundaryParameters *	boundary_parameters = nullptr
	User-inputs constraint parameters.
const SpatialDiscretization< dim > *	spatial_discretization = nullptr
	User-inputs discretization.
const DoFManager< dim, degree > *	dof_manager = nullptr
	Dof manager pointer.
const PDEOperatorBase< dim, degree, number > *	pde_operator = nullptr
	PDE operator.
const SimulationTimer *	sim_timer = nullptr
	Simulation time for time-dependent constraints.
std::vector< dealii::AffineConstraints< number > >	field_constraints
	Constraints. Outer vector is indexed by field index.
std::array< dealii::AffineConstraints< number >, 2 >	generic_constraints
	Constraints not specific to any field. We need this for invm.
std::vector< std::vector< dealii::AffineConstraints< number > > >	mg_field_constraints
	Constraints. Outer vector is indexed by field index. Inner vector is indexed by relative mg level.
std::vector< std::array< dealii::AffineConstraints< number >, 2 > >	mg_generic_constraints
	Constraints not specific to any field. We need this for invm.

Detailed Description

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

The class handles the generation and application of boundary conditions based on the user-inputs.

Constructor & Destructor Documentation

ConstraintManager()

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

ConstraintManager< dim, degree, number >::ConstraintManager ( )

default

Constructor.

Member Function Documentation

get_field_constraint()

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

const dealii::AffineConstraints< number > & ConstraintManager< dim, degree, number >::get_field_constraint ( Types::Index index ) const

nodiscard

Getter function for the constraint of an index.

get_field_constraints()

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

std::vector< const dealii::AffineConstraints< number > * > ConstraintManager< dim, degree, number >::get_field_constraints ( ) const

nodiscard

Getter function for the constraints.

get_generic_constraint()

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

const dealii::AffineConstraints< number > & ConstraintManager< dim, degree, number >::get_generic_constraint ( unsigned int rank ) const

nodiscard

Getter function for the constraint of an index.

get_generic_constraints()

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

const std::array< dealii::AffineConstraints< number >, 2 > & ConstraintManager< dim, degree, number >::get_generic_constraints ( ) const

nodiscard

Getter function for the constraints.

get_mg_field_constraint()

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

const dealii::AffineConstraints< number > & ConstraintManager< dim, degree, number >::get_mg_field_constraint ( Types::Index index, unsigned int relative_level ) const

nodiscard

Getter function for the constraint of an index (constant reference).

get_mg_field_constraints()

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

std::vector< const dealii::AffineConstraints< number > * > ConstraintManager< dim, degree, number >::get_mg_field_constraints ( unsigned int relative_level ) const

nodiscard

Getter function for the constraints.

get_mg_field_constraints_levels()

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

const std::vector< std::vector< dealii::AffineConstraints< number > > > & ConstraintManager< dim, degree, number >::get_mg_field_constraints_levels ( ) const

nodiscard

Getter function for a selection of the constraints.

get_mg_generic_constraint()

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

const dealii::AffineConstraints< number > & ConstraintManager< dim, degree, number >::get_mg_generic_constraint ( unsigned int rank, unsigned int relative_level ) const

nodiscard

Getter function for the constraint of an index (constant reference).

get_mg_generic_constraints()

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

const std::array< dealii::AffineConstraints< number >, 2 > & ConstraintManager< dim, degree, number >::get_mg_generic_constraints ( unsigned int relative_level ) const

nodiscard

Getter function for the constraints.

get_mg_generic_constraints_levels()

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

const std::vector< std::array< dealii::AffineConstraints< number >, 2 > > & ConstraintManager< dim, degree, number >::get_mg_generic_constraints_levels ( ) const

nodiscard

Getter function for the constraints.

init()

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

PRISMS_PF_BEGIN_NAMESPACE void ConstraintManager< dim, degree, number >::init	(	const BoundaryParameters &	_boundary_parameters,
		const SpatialDiscretization< dim > &	_spatial_discretization,
		const DoFManager< dim, degree > &	_dof_manager,
		const PDEOperatorBase< dim, degree, number > &	_pde_operator,
		const SimulationTimer &	_sim_timer )

Initialize the constraint manager.

make_bc_constraints()

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

void ConstraintManager< dim, degree, number >::make_bc_constraints ( dealii::AffineConstraints< number > & constraint, const dealii::DoFHandler< dim > & dof_handler, const BoundaryConditionSet & boundary_condition, TensorRank tensor_rank, Types::Index field_index )

private

Add boundary conditions to a single constraint.

make_constraints_for_single_field()

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

void ConstraintManager< dim, degree, number >::make_constraints_for_single_field ( dealii::AffineConstraints< number > & constraint, const dealii::DoFHandler< dim > & dof_handler, const BoundaryConditionSet & _field_constraints, TensorRank tensor_rank, Types::Index field_index, unsigned int relative_level = -1 )

private

Construct constraints for a single field based on the boundary conditions.

make_dirichlet_constraints()

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

void ConstraintManager< dim, degree, number >::make_dirichlet_constraints ( dealii::AffineConstraints< number > & _constraints, const dealii::DoFHandler< dim > & dof_handler, const unsigned int & boundary_id, const unsigned int & field_index, const bool & is_vector_field, const dealii::ComponentMask & mask ) const

private

Make dirichlet constraints.

make_one_boundary_constraint()

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

void ConstraintManager< dim, degree, number >::make_one_boundary_constraint ( dealii::AffineConstraints< number > & _constraints, unsigned int boundary_id, unsigned int component, Condition boundary_type, const dealii::DoFHandler< dim > & dof_handler, TensorRank tensor_rank, Types::Index field_index ) const

private

Apply constraints for common boundary conditions.

reinit()

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

void ConstraintManager< dim, degree, number >::reinit

(

const std::vector< FieldAttributes > &

field_attributes

)

Make constraints based on the inputs of the constructor.

update_time_dependent_constraints()

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

void ConstraintManager< dim, degree, number >::update_time_dependent_constraints

(

const std::vector< FieldAttributes > &

field_attributes

)

Update time-dependent constraints. For now this only updates the Dirichlet constraints.

Member Data Documentation

boundary_parameters

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

const BoundaryParameters* ConstraintManager< dim, degree, number >::boundary_parameters = nullptr

private

User-inputs constraint parameters.

dof_manager

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

const DoFManager<dim, degree>* ConstraintManager< dim, degree, number >::dof_manager = nullptr

private

Dof manager pointer.

field_constraints

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

std::vector<dealii::AffineConstraints<number> > ConstraintManager< dim, degree, number >::field_constraints

private

Constraints. Outer vector is indexed by field index.

generic_constraints

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

std::array<dealii::AffineConstraints<number>, 2> ConstraintManager< dim, degree, number >::generic_constraints

private

Constraints not specific to any field. We need this for invm.

mg_field_constraints

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

std::vector<std::vector<dealii::AffineConstraints<number> > > ConstraintManager< dim, degree, number >::mg_field_constraints

private

Constraints. Outer vector is indexed by field index. Inner vector is indexed by relative mg level.

mg_generic_constraints

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

std::vector<std::array<dealii::AffineConstraints<number>, 2> > ConstraintManager< dim, degree, number >::mg_generic_constraints

private

Constraints not specific to any field. We need this for invm.

pde_operator

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

const PDEOperatorBase<dim, degree, number>* ConstraintManager< dim, degree, number >::pde_operator = nullptr

private

PDE operator.

scalar_empty_mask

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

const dealii::ComponentMask ConstraintManager< dim, degree, number >::scalar_empty_mask

static

sim_timer

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

const SimulationTimer* ConstraintManager< dim, degree, number >::sim_timer = nullptr

private

Simulation time for time-dependent constraints.

spatial_discretization

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

const SpatialDiscretization<dim>* ConstraintManager< dim, degree, number >::spatial_discretization = nullptr

private

User-inputs discretization.

vector_component_mask

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

const std::array<dealii::ComponentMask, dim> ConstraintManager< dim, degree, number >::vector_component_mask

static

Create a component mask.

---

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

• /__w/phaseField/phaseField/include/prismspf/core/constraint_manager.h
• /__w/phaseField/phaseField/src/core/constraint_manager.cc