Mesh< dim > Struct Template Reference

Triangulation base class. More...

#include <spatial_discretization.h>

Inheritance diagram for Mesh< dim >:

Public Types
using	Triangulation

Public Member Functions
	Mesh ()=default
	Constructor.
virtual void	generate_mesh (Triangulation &triangulation) const =0
	Generate the mesh.
virtual void	mark_boundaries (Triangulation &triangulation) const
	Mark the boundaries of the mesh.
virtual double	distance (const dealii::Point< dim > &point_1, const dealii::Point< dim > &point_2) const
	Calculation the distance between two points considering periodic boundaries.
template<typename real1, typename real2>
double	distance (const dealii::Point< dim, real1 > &point_1, const dealii::Point< dim, real2 > &point_2) const
	Calculation the distance between two points considering periodic boundaries.
template<typename real1>
dealii::VectorizedArray< real1 >	distance (const dealii::Point< dim, dealii::VectorizedArray< real1 > > &point_1, const dealii::Point< dim, dealii::VectorizedArray< real1 > > &point_2) const
	Calculation the distance between two points considering periodic boundaries.
virtual void	validate () const
	Validate.
virtual std::list< PeriodicPair< dim > >	periodicity_set () const
	Periodicity set.
void	mark_periodic (Triangulation &triangulation) const
	Mark the periodic faces of the mesh.
template<typename number>
void	mark_periodic (const dealii::DoFHandler< dim > &dof_handler, dealii::AffineConstraints< number > &constraints) const
	Mark the periodic faces of the mesh.
template<unsigned int dim>
void	mark_periodic (typename Mesh< dim >::Triangulation &triangulation) const

Detailed Description

template<unsigned int dim>
struct Mesh< dim >

Triangulation base class.

Member Typedef Documentation

Triangulation

template<unsigned int dim>

using Mesh< dim >::Triangulation

Initial value:

 
    std::conditional_t<dim == 1,
                       dealii::Triangulation<dim>,
                       dealii::parallel::distributed::Triangulation<dim>>

Constructor & Destructor Documentation

Mesh()

template<unsigned int dim>

Mesh< dim >::Mesh ( )

default

Constructor.

Member Function Documentation

distance() [1/3]

template<unsigned int dim>

PRISMS_PF_BEGIN_NAMESPACE double Mesh< dim >::distance ( const dealii::Point< dim > & point_1, const dealii::Point< dim > & point_2 ) const

virtual

Calculation the distance between two points considering periodic boundaries.

Reimplemented in RectangularMesh< dim >, and SpatialDiscretization< dim >.

distance() [2/3]

template<unsigned int dim>

template<typename real1>

dealii::VectorizedArray< real1 > Mesh< dim >::distance	(	const dealii::Point< dim, dealii::VectorizedArray< real1 > > &	point_1,
		const dealii::Point< dim, dealii::VectorizedArray< real1 > > &	point_2 ) const

Calculation the distance between two points considering periodic boundaries.

distance() [3/3]

template<unsigned int dim>

template<typename real1, typename real2>

double Mesh< dim >::distance	(	const dealii::Point< dim, real1 > &	point_1,
		const dealii::Point< dim, real2 > &	point_2 ) const

Calculation the distance between two points considering periodic boundaries.

generate_mesh()

template<unsigned int dim>

virtual void Mesh< dim >::generate_mesh ( Triangulation & triangulation ) const

pure virtual

Generate the mesh.

Implemented in RectangularMesh< dim >, SpatialDiscretization< dim >, and SphericalMesh< dim >.

mark_boundaries()

template<unsigned int dim>

virtual void Mesh< dim >::mark_boundaries ( Triangulation & triangulation ) const

inlinevirtual

Mark the boundaries of the mesh.

Reimplemented in RectangularMesh< dim >, SpatialDiscretization< dim >, and SphericalMesh< dim >.

mark_periodic() [1/3]

template<unsigned int dim>

template<typename number>

void Mesh< dim >::mark_periodic	(	const dealii::DoFHandler< dim > &	dof_handler,
		dealii::AffineConstraints< number > &	constraints ) const

Mark the periodic faces of the mesh.

mark_periodic() [2/3]

template<unsigned int dim>

void Mesh< dim >::mark_periodic

(

Triangulation &

triangulation

)

const

Mark the periodic faces of the mesh.

mark_periodic() [3/3]

template<unsigned int dim>

template<unsigned int dim>

void Mesh< dim >::mark_periodic

(

typename Mesh< dim >::Triangulation &

triangulation

)

const

periodicity_set()

template<unsigned int dim>

std::list< PeriodicPair< dim > > Mesh< dim >::periodicity_set ( ) const

virtual

Periodicity set.

This set contains all the information about periodicity for the system. Each entry contain tuple with three entries: the first boundary id, the second boundary id, and the direction.

Reimplemented in RectangularMesh< dim >, and SpatialDiscretization< dim >.

validate()

template<unsigned int dim>

virtual void Mesh< dim >::validate ( ) const

inlinevirtual

Validate.

Reimplemented in RectangularMesh< dim >, and SphericalMesh< dim >.

---

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

• /__w/phaseField/phaseField/include/prismspf/user_inputs/spatial_discretization.h
• /__w/phaseField/phaseField/src/user_inputs/spatial_discretization.cc