RefinementCriterion Struct Reference

#include <grid_refiner_criterion.h>

Public Member Functions
	RefinementCriterion (const RefinementFlags &_criterion=RefinementFlags::Nothing, const double &_value_lower_bound=DBL_MAX, const double &_value_upper_bound=DBL_MAX, const double &_gradient_lower_bound=DBL_MAX)
	Constructor.
bool	value_in_open_range (double value) const
	Whether the provided value is in the open range for the value refinement criteria.
bool	gradient_magnitude_above_threshold (double gradient_magnitude) const
	Whether the provided gradient magnitude is greater than the minimum value.
std::string	criterion_string () const
	Convert refinement criterion type to string.

Public Attributes
RefinementFlags	criterion = RefinementFlags::Nothing
double	value_lower_bound = DBL_MAX
double	value_upper_bound = DBL_MAX
double	gradient_lower_bound = DBL_MAX

Detailed Description

This class holds information for a determining whether the mesh should be refined.

TODO (landinjm): This should likely be part of VariableAttributes

Constructor & Destructor Documentation

RefinementCriterion()

RefinementCriterion::RefinementCriterion ( const RefinementFlags &  _criterion = RefinementFlags::Nothing, const double &  _value_lower_bound = DBL_MAX, const double &  _value_upper_bound = DBL_MAX, const double &  _gradient_lower_bound = DBL_MAX  )

inlineexplicit

Constructor.

Member Function Documentation

criterion_string()

std::string RefinementCriterion::criterion_string ( ) const

inline

Convert refinement criterion type to string.

gradient_magnitude_above_threshold()

bool RefinementCriterion::gradient_magnitude_above_threshold ( double  gradient_magnitude ) const

inline

Whether the provided gradient magnitude is greater than the minimum value.

value_in_open_range()

bool RefinementCriterion::value_in_open_range ( double  value ) const

inline

Whether the provided value is in the open range for the value refinement criteria.

Member Data Documentation

criterion

RefinementFlags RefinementCriterion::criterion = RefinementFlags::Nothing

gradient_lower_bound

double RefinementCriterion::gradient_lower_bound = DBL_MAX

value_lower_bound

double RefinementCriterion::value_lower_bound = DBL_MAX

value_upper_bound

double RefinementCriterion::value_upper_bound = DBL_MAX

---

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

• /home/runner/work/phaseField/phaseField/include/prismspf/core/grid_refiner_criterion.h