SphericalMesh< dim > Struct Template Reference

Class for spherical mesh parameters. More...

#include <spatial_discretization.h>

Inheritance diagram for SphericalMesh< dim >:

Collaboration diagram for SphericalMesh< dim >:

Public Types
enum	Boundary { Surface = 0 }
	Simple enum for boundary ids to natural language. More...
using	Triangulation = typename Mesh<dim>::Triangulation
Public Types inherited from Mesh< dim >
using	Triangulation

Public Member Functions
	SphericalMesh ()=default
	Constructor.
	SphericalMesh (double _radius)
	Constructor.
void	generate_mesh (Triangulation &triangulation) const override
	Generate the mesh.
void	mark_boundaries (Triangulation &triangulation) const override
	Mark the boundaries of the mesh.
void	assign_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the parameters read from an input file to this object.
void	validate () const override
	Validate.
Public Member Functions inherited from Mesh< dim >
	Mesh ()=default
	Constructor.
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 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

Static Public Member Functions
static void	declare_parameters (dealii::ParameterHandler &parameter_handler)
	Declare the parameters to be read from an input file.

Public Attributes
double	radius = 0.0
	Radius of the spherical domain.

Detailed Description

template<unsigned int dim>
struct SphericalMesh< dim >

Class for spherical mesh parameters.

Member Typedef Documentation

Triangulation

template<unsigned int dim>

using SphericalMesh< dim >::Triangulation = typename Mesh<dim>::Triangulation

Member Enumeration Documentation

Boundary

template<unsigned int dim>

enum SphericalMesh::Boundary

Simple enum for boundary ids to natural language.

Enumerator
Surface

Constructor & Destructor Documentation

SphericalMesh() [1/2]

template<unsigned int dim>

SphericalMesh< dim >::SphericalMesh ( )

default

Constructor.

SphericalMesh() [2/2]

template<unsigned int dim>

SphericalMesh< dim >::SphericalMesh ( double _radius )

explicit

Constructor.

Member Function Documentation

assign_parameters()

template<unsigned int dim>

void SphericalMesh< dim >::assign_parameters

(

dealii::ParameterHandler &

parameter_handler

)

Assign the parameters read from an input file to this object.

declare_parameters()

template<unsigned int dim>

void SphericalMesh< dim >::declare_parameters ( dealii::ParameterHandler & parameter_handler )

static

Declare the parameters to be read from an input file.

generate_mesh()

template<unsigned int dim>

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

overridevirtual

Generate the mesh.

Implements Mesh< dim >.

mark_boundaries()

template<unsigned int dim>

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

overridevirtual

Mark the boundaries of the mesh.

Reimplemented from Mesh< dim >.

validate()

template<unsigned int dim>

void SphericalMesh< dim >::validate ( ) const

overridevirtual

Validate.

Reimplemented from Mesh< dim >.

Member Data Documentation

radius

template<unsigned int dim>

double SphericalMesh< dim >::radius = 0.0

Radius of the spherical domain.

---

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