SpatialDiscretization< dim > Struct Template Reference

Struct that holds spatial discretization parameters. More...

#include <spatial_discretization.h>

Public Member Functions
void	print_parameter_summary () const
	Print parameters to summary.log.
void	validate ()
	Validate.
bool	should_refine_mesh (unsigned int increment) const
	Whether the provided increment is a valid grid refinement step.

Public Attributes
TriangulationType	type = TriangulationType::Rectangular
RectangularMesh< dim >	rectangular_mesh
SphericalMesh< dim >	spherical_mesh
unsigned int	global_refinement = 0
unsigned int	degree = 1
bool	has_adaptivity = false
unsigned int	max_refinement = 0
unsigned int	min_refinement = 0
unsigned int	remeshing_period = UINT_MAX
std::map< std::string, RefinementCriterion >	refinement_criteria

Detailed Description

template<unsigned int dim>
struct SpatialDiscretization< dim >

Struct that holds spatial discretization parameters.

Member Function Documentation

print_parameter_summary()

template<unsigned int dim>

void SpatialDiscretization< dim >::print_parameter_summary ( ) const

inline

Print parameters to summary.log.

should_refine_mesh()

template<unsigned int dim>

bool SpatialDiscretization< dim >::should_refine_mesh ( unsigned int  increment ) const

inline

Whether the provided increment is a valid grid refinement step.

validate()

template<unsigned int dim>

void SpatialDiscretization< dim >::validate ( )

inline

Validate.

Member Data Documentation

degree

template<unsigned int dim>

unsigned int SpatialDiscretization< dim >::degree = 1

global_refinement

template<unsigned int dim>

unsigned int SpatialDiscretization< dim >::global_refinement = 0

has_adaptivity

template<unsigned int dim>

bool SpatialDiscretization< dim >::has_adaptivity = false

max_refinement

template<unsigned int dim>

unsigned int SpatialDiscretization< dim >::max_refinement = 0

min_refinement

template<unsigned int dim>

unsigned int SpatialDiscretization< dim >::min_refinement = 0

rectangular_mesh

template<unsigned int dim>

RectangularMesh<dim> SpatialDiscretization< dim >::rectangular_mesh

refinement_criteria

template<unsigned int dim>

std::map<std::string, RefinementCriterion> SpatialDiscretization< dim >::refinement_criteria

remeshing_period

template<unsigned int dim>

unsigned int SpatialDiscretization< dim >::remeshing_period = UINT_MAX

spherical_mesh

template<unsigned int dim>

SphericalMesh<dim> SpatialDiscretization< dim >::spherical_mesh

type

template<unsigned int dim>

TriangulationType SpatialDiscretization< dim >::type = TriangulationType::Rectangular

---

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

• /home/runner/work/phaseField/phaseField/include/prismspf/core/initial_conditions.h
• /home/runner/work/phaseField/phaseField/include/prismspf/user_inputs/spatial_discretization.h