Helper class to define, parameterize and create a level set function used in meshing, often to correct the position of nodes on a surface. More...

#include <LevelSetMeshingHelper.h>

Inheritance diagram for LevelSetMeshingHelper:

[legend]

Public Types
typedef GenericSymFunction< is_ad >	SymFunction
	Shorthand for an autodiff function parser object. More...

typedef std::shared_ptr< SymFunction >	SymFunctionPtr
	Shorthand for an smart pointer to an autodiff function parser object. More...

Public Member Functions
	LevelSetMeshingHelper (const InputParameters &parameters)

void	setParserFeatureFlags (SymFunctionPtr &) const
	apply input parameters to internal feature flags of the parser object More...

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	FailureMethod
	Enum for failure method. More...

Protected Member Functions
Real	levelSetEvaluator (const Point &point)
	Evaluate the level set function at a given point. More...

void	levelSetCorrection (Node &node)
	Correct the position of a node based on the level set function. More...

GenericReal< is_ad >	evaluate (SymFunctionPtr &, const std::string &object_name="")
	Evaluate FParser object and check EvalError. More...

GenericReal< is_ad >	evaluate (SymFunctionPtr &, const std::vector< GenericReal< is_ad >> &, const std::string &object_name="")
	Evaluate FParser object and check EvalError. More...

void	addFParserConstants (SymFunctionPtr &parser, const std::vector< std::string > &constant_names, const std::vector< std::string > &constant_expressions) const
	add constants (which can be complex expressions) to the parser object More...

virtual void	functionsOptimize (SymFunctionPtr &parsed_function)
	run FPOptimizer on the parsed function More...

void	functionsOptimize (SymFunctionPtr &parsed_function)

void	functionsOptimize (SymFunctionPtr &parsed_function)

void	parsedFunctionSetup (SymFunctionPtr &function, const std::string &expression, const std::string &variables, const std::vector< std::string > &constant_names, const std::vector< std::string > &constant_expressions, const libMesh::Parallel::Communicator &comm) const
	Performs setup steps on a SymFunction. More...

Protected Attributes
const unsigned int	_max_level_set_correction_iterations
	Maximum number of iterations to correct the nodes based on the level set function. More...

SymFunctionPtr	_func_level_set
	function parser object describing the level set More...

enum FunctionParserUtils::FailureMethod	_evalerror_behavior

const Real	_quiet_nan
	appropriate not a number value to return More...

std::vector< GenericReal< is_ad > >	_func_params
	Array to stage the parameters passed to the functions when calling Eval. More...

const Real	_epsilon
	fuzzy comparison tolerance More...


bool	_enable_jit
	feature flags More...

bool	_enable_ad_cache

bool	_disable_fpoptimizer

bool	_enable_auto_optimize

Static Protected Attributes
static const char *	_eval_error_msg []
	table of FParser eval error codes More...

Detailed Description

Helper class to define, parameterize and create a level set function used in meshing, often to correct the position of nodes on a surface.

Definition at line 19 of file LevelSetMeshingHelper.h.

Member Typedef Documentation

◆ SymFunction

typedef GenericSymFunction<is_ad> FunctionParserUtils< is_ad >::SymFunction

inherited

Shorthand for an autodiff function parser object.

Definition at line 62 of file FunctionParserUtils.h.

◆ SymFunctionPtr

typedef std::shared_ptr<SymFunction> FunctionParserUtils< is_ad >::SymFunctionPtr

inherited

Shorthand for an smart pointer to an autodiff function parser object.

Definition at line 65 of file FunctionParserUtils.h.

Member Enumeration Documentation

◆ FailureMethod

enum FunctionParserUtils::FailureMethod

strongprotectedinherited

Enum for failure method.

Definition at line 116 of file FunctionParserUtils.h.

116 { nan, nan_warning, error, exception } _evalerror_behavior;

FunctionParserUtils< false >::_evalerror_behavior

enum FunctionParserUtils::FailureMethod _evalerror_behavior

Constructor & Destructor Documentation

◆ LevelSetMeshingHelper()

LevelSetMeshingHelper::LevelSetMeshingHelper ( const InputParameters & parameters )

Definition at line 31 of file LevelSetMeshingHelper.C.

   : FunctionParserUtils<false>(parameters),
     _max_level_set_correction_iterations(
         parameters.get<unsigned int>("max_level_set_correction_iterations"))
 {
   if (parameters.isParamValid("level_set"))
   {
     _func_level_set = std::make_shared<SymFunction>();
     // set FParser internal feature flags
     setParserFeatureFlags(_func_level_set);
     if (parameters.isParamValid("constant_names") &&
         parameters.isParamValid("constant_expressions"))
       addFParserConstants(_func_level_set,
                           parameters.get<std::vector<std::string>>("constant_names"),
                           parameters.get<std::vector<std::string>>("constant_expressions"));
     if (_func_level_set->Parse(parameters.get<std::string>("level_set"), "x,y,z") >= 0)
       mooseError(
           "Invalid function f(x,y,z)\n", _func_level_set, ".\n", _func_level_set->ErrorMsg());
 
     _func_params.resize(3);
   }
 }

Member Function Documentation

◆ addFParserConstants()

void FunctionParserUtils< is_ad >::addFParserConstants	(	SymFunctionPtr &	parser,
		const std::vector< std::string > &	constant_names,
		const std::vector< std::string > &	constant_expressions
	)		const

protectedinherited

add constants (which can be complex expressions) to the parser object

Definition at line 153 of file FunctionParserUtils.C.

Referenced by LevelSetMeshingHelper(), ParsedCurveGenerator::ParsedCurveGenerator(), and ParsedODEKernel::ParsedODEKernel().

 {
   // check constant vectors
   unsigned int nconst = constant_expressions.size();
   if (nconst != constant_names.size())
     mooseError("The parameter vectors constant_names (size " +
                std::to_string(constant_names.size()) + ") and constant_expressions (size " +
                std::to_string(nconst) + ") must have equal length.");
 
   // previously evaluated constant_expressions may be used in following constant_expressions
   std::vector<Real> constant_values(nconst);
 
   for (unsigned int i = 0; i < nconst; ++i)
   {
     // no need to use dual numbers for the constant expressions
     auto expression = std::make_shared<FunctionParserADBase<Real>>();
 
     // add previously evaluated constants
     for (unsigned int j = 0; j < i; ++j)
       if (!expression->AddConstant(constant_names[j], constant_values[j]))
         mooseError("Invalid constant name: ", constant_names[j], " and value ", constant_values[j]);
 
     // build the temporary constant expression function
     if (expression->Parse(constant_expressions[i], "") >= 0)
       mooseError("Invalid constant expression\n",
                  constant_expressions[i],
                  "\n in parsed function object.\n",
                  expression->ErrorMsg());
 
     constant_values[i] = expression->Eval(NULL);
 
     if (!parser->AddConstant(constant_names[i], constant_values[i]))
       mooseError("Invalid constant name in parsed function object");
   }
 }

◆ evaluate() [1/2]

GenericReal< is_ad > FunctionParserUtils< is_ad >::evaluate	(	SymFunctionPtr &	parser,
		const std::string &	object_name = `""`
	)

protectedinherited

Evaluate FParser object and check EvalError.

Definition at line 87 of file FunctionParserUtils.C.

Referenced by ParsedSubdomainIDsGenerator::assignElemSubdomainID(), ParsedSubdomainMeshGenerator::assignElemSubdomainID(), ParsedConvergence::checkConvergence(), ParsedODEKernel::computeQpJacobian(), ParsedODEKernel::computeQpOffDiagJacobianScalar(), ParsedODEKernel::computeQpResidual(), ParsedVectorAux::computeValue(), ParsedAux::computeValue(), ArrayParsedAux::computeValue(), ParsedScalarReporter::finalize(), ParsedVectorReporter::finalize(), ParsedVectorRealReductionReporter::finalize(), ParsedVectorVectorRealReductionReporter::finalize(), ParsedPostprocessor::finalize(), ParsedExtraElementIDGenerator::generate(), ParsedGenerateNodeset::generate(), ParsedNodeTransformGenerator::generate(), ParsedCurveGenerator::generate(), ParsedGenerateSideset::generate(), ParsedDownSelectionPositions::initialize(), levelSetEvaluator(), ProjectSideSetOntoLevelSetGenerator::levelSetEvaluator(), CutMeshByLevelSetGeneratorBase::levelSetEvaluator(), ParsedCurveGenerator::pointCalculator(), ParsedElementDeletionGenerator::shouldDelete(), and SolutionUserObject::solutionSampleTime().

 {
   return evaluate(parser, _func_params, name);
 }

◆ evaluate() [2/2]

GenericReal< is_ad > FunctionParserUtils< is_ad >::evaluate	(	SymFunctionPtr &	parser,
		const std::vector< GenericReal< is_ad >> &	func_params,
		const std::string &	object_name = `""`
	)

protectedinherited

Evaluate FParser object and check EvalError.

This version uses a supplied vector of function parameters, which is useful if an object uses more than one parsed function, which may have different function parameter values.

Definition at line 94 of file FunctionParserUtils.C.

 {
   using std::isnan;
 
   // null pointer is a shortcut for vanishing derivatives, see functionsOptimize()
   if (parser == NULL)
     return 0.0;
 
   // set desired epsilon
   auto tmp_eps = parser->epsilon();
   parser->setEpsilon(_epsilon);
 
   // evaluate expression
   auto result = parser->Eval(func_params.data());
 
   // restore epsilon
   parser->setEpsilon(tmp_eps);
 
   // fetch fparser evaluation error (set to unknown if the JIT result is nan)
   int error_code = _enable_jit ? (isnan(result) ? -1 : 0) : parser->EvalError();
 
   // no error
   if (error_code == 0)
     return result;
 
   // hard fail or return not a number
   switch (_evalerror_behavior)
   {
     case FailureMethod::nan:
       return _quiet_nan;
 
     case FailureMethod::nan_warning:
       mooseWarning("In ",
                    name,
                    ": Parsed function evaluation encountered an error: ",
                    _eval_error_msg[(error_code < 0 || error_code > 5) ? 0 : error_code]);
       return _quiet_nan;
 
     case FailureMethod::error:
       mooseError("In ",
                  name,
                  ": Parsed function evaluation encountered an error: ",
                  _eval_error_msg[(error_code < 0 || error_code > 5) ? 0 : error_code]);
 
     case FailureMethod::exception:
       mooseException("In ",
                      name,
                      ": Parsed function evaluation encountered an error: ",
                      _eval_error_msg[(error_code < 0 || error_code > 5) ? 0 : error_code],
                      "\n Cutting timestep");
   }
 
   return _quiet_nan;
 }

◆ functionsOptimize() [1/3]

virtual void FunctionParserUtils< is_ad >::functionsOptimize ( SymFunctionPtr & parsed_function )

protectedvirtualinherited

run FPOptimizer on the parsed function

◆ functionsOptimize() [2/3]

void FunctionParserUtils< true >::functionsOptimize ( SymFunctionPtr & parsed_function )

protectedinherited

◆ functionsOptimize() [3/3]

void FunctionParserUtils< true >::functionsOptimize ( SymFunctionPtr & parsed_function )

protectedinherited

Definition at line 211 of file FunctionParserUtils.C.

 {
   // set desired epsilon for optimization!
   auto tmp_eps = parsed_function->epsilon();
   parsed_function->setEpsilon(_epsilon);
 
   // base function
   if (!_disable_fpoptimizer)
     parsed_function->Optimize();
   if (!_enable_jit || !parsed_function->JITCompile())
     mooseError("AD parsed objects require JIT compilation to be enabled and working.");
 
   parsed_function->setEpsilon(tmp_eps);
 }

◆ levelSetCorrection()

void LevelSetMeshingHelper::levelSetCorrection ( Node & node )

protected

Correct the position of a node based on the level set function.

Parameters

node	The node to be corrected

Definition at line 61 of file LevelSetMeshingHelper.C.

Referenced by Boundary2DDelaunayGenerator::General2DDelaunay(), and SurfaceSubdomainsDelaunayRemesher::General2DDelaunay().

 {
   // Based on the given level set, we try to move the node in its normal direction
   const Real diff = libMesh::TOLERANCE * 10.0; // A small value to perturb the node
   const Real original_eval = levelSetEvaluator(node);
   const Real xp_eval = levelSetEvaluator(node + Point(diff, 0.0, 0.0));
   const Real yp_eval = levelSetEvaluator(node + Point(0.0, diff, 0.0));
   const Real zp_eval = levelSetEvaluator(node + Point(0.0, 0.0, diff));
   const Real xm_eval = levelSetEvaluator(node - Point(diff, 0.0, 0.0));
   const Real ym_eval = levelSetEvaluator(node - Point(0.0, diff, 0.0));
   const Real zm_eval = levelSetEvaluator(node - Point(0.0, 0.0, diff));
   const Point grad = Point((xp_eval - xm_eval) / (2.0 * diff),
                            (yp_eval - ym_eval) / (2.0 * diff),
                            (zp_eval - zm_eval) / (2.0 * diff));
   const Real xyz_diff = -original_eval / grad.contract(grad);
   node(0) += xyz_diff * grad(0);
   node(1) += xyz_diff * grad(1);
   node(2) += xyz_diff * grad(2);
 }

◆ levelSetEvaluator()

Real LevelSetMeshingHelper::levelSetEvaluator ( const Point & point )

protected

Evaluate the level set function at a given point.

Parameters

point The point at which the level set function is to be evaluated

Returns: the value of the level set function at the given point

Definition at line 55 of file LevelSetMeshingHelper.C.

Referenced by Boundary2DDelaunayGenerator::General2DDelaunay(), SurfaceSubdomainsDelaunayRemesher::General2DDelaunay(), and levelSetCorrection().

 {
   return evaluate(_func_level_set, std::vector<Real>({point(0), point(1), point(2), 0}));
 }

◆ parsedFunctionSetup()

void FunctionParserUtils< is_ad >::parsedFunctionSetup	(	SymFunctionPtr &	function,
		const std::string &	expression,
		const std::string &	variables,
		const std::vector< std::string > &	constant_names,
		const std::vector< std::string > &	constant_expressions,
		const libMesh::Parallel::Communicator &	comm
	)		const

protectedinherited

Performs setup steps on a SymFunction.

Parameters

function	reference to pointer to the function to set up
expression	expression to parse
variables	comma separated string holding all the variables of the expression
constant_names	vector of names (symbols) of constants in the expression
constant_expressions	vectors of expressions (=values) of constants in the expression
comm	communicator used to stagger JIT file creations

Definition at line 228 of file FunctionParserUtils.C.

Referenced by ArrayParsedAux::ArrayParsedAux(), CutMeshByLevelSetGenerator::CutMeshByLevelSetGenerator(), ParsedSubdomainGeneratorBase::functionInitialize(), ParsedConvergence::makeParsedFunction(), ParsedElementDeletionGenerator::ParsedElementDeletionGenerator(), ParsedExtraElementIDGenerator::ParsedExtraElementIDGenerator(), ParsedGenerateNodeset::ParsedGenerateNodeset(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedNodeTransformGenerator::ParsedNodeTransformGenerator(), ParsedPostprocessor::ParsedPostprocessor(), ParsedReporterBase::ParsedReporterBase(), ProjectSideSetOntoLevelSetGenerator::ProjectSideSetOntoLevelSetGenerator(), and SolutionUserObject::SolutionUserObject().

 {
   // set FParser internal feature flags
   setParserFeatureFlags(function);
 
   // add the constant expressions
   addFParserConstants(function, constant_names, constant_expressions);
 
   // parse function
   if (function->Parse(expression, variables) >= 0)
     mooseError("Invalid function\n", expression, "\nError:\n", function->ErrorMsg());
 
   // optimize
   if (!_disable_fpoptimizer)
     function->Optimize();
 
   // just-in-time compile
   if (_enable_jit)
   {
     // let rank 0 do the JIT compilation first
     if (comm.rank() != 0)
       comm.barrier();
 
     function->JITCompile();
 
     // wait for ranks > 0 to catch up
     if (comm.rank() == 0)
       comm.barrier();
   }
 }

◆ setParserFeatureFlags()

void FunctionParserUtils< is_ad >::setParserFeatureFlags ( SymFunctionPtr & parser ) const

inherited

apply input parameters to internal feature flags of the parser object

Definition at line 79 of file FunctionParserUtils.C.

Referenced by CutMeshByPlaneGenerator::CutMeshByPlaneGenerator(), LevelSetMeshingHelper(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedODEKernel::ParsedODEKernel(), and TransfiniteMeshGenerator::TransfiniteMeshGenerator().

 {
   parser->SetADFlags(SymFunction::ADCacheDerivatives, _enable_ad_cache);
   parser->SetADFlags(SymFunction::ADAutoOptimize, _enable_auto_optimize);
 }

◆ validParams()

InputParameters LevelSetMeshingHelper::validParams ( )

static

Definition at line 13 of file LevelSetMeshingHelper.C.

Referenced by Boundary2DDelaunayGenerator::validParams(), and SurfaceSubdomainsDelaunayRemesher::validParams().

 {
   InputParameters params = FunctionParserUtils<false>::validParams();
   params.renameParameterGroup("Parsed expression advanced", "Level set shape parsed expression");
 
   params.addParam<std::string>(
       "level_set",
       "Level set used to achieve more accurate reverse projection compared to interpolation.");
   params.addParam<unsigned int>(
       "max_level_set_correction_iterations",
       3,
       "Maximum number of iterations to correct the nodes based on the level set function.");
   params.addParamNamesToGroup("level_set max_level_set_correction_iterations",
                               "Level set shape correction");
 
   return params;
 }

Member Data Documentation

◆ _disable_fpoptimizer

bool FunctionParserUtils< is_ad >::_disable_fpoptimizer

protectedinherited

Definition at line 111 of file FunctionParserUtils.h.

Referenced by ParsedODEKernel::ParsedODEKernel().

◆ _enable_ad_cache

bool FunctionParserUtils< is_ad >::_enable_ad_cache

protectedinherited

Definition at line 110 of file FunctionParserUtils.h.

◆ _enable_auto_optimize

bool FunctionParserUtils< is_ad >::_enable_auto_optimize

protectedinherited

Definition at line 112 of file FunctionParserUtils.h.

◆ _enable_jit

bool FunctionParserUtils< is_ad >::_enable_jit

protectedinherited

feature flags

Definition at line 109 of file FunctionParserUtils.h.

Referenced by ParsedODEKernel::ParsedODEKernel().

◆ _epsilon

const Real FunctionParserUtils< is_ad >::_epsilon

protectedinherited

fuzzy comparison tolerance

Definition at line 128 of file FunctionParserUtils.h.

◆ _eval_error_msg

const char * FunctionParserUtils< is_ad >::_eval_error_msg

staticprotectedinherited

table of FParser eval error codes

Definition at line 122 of file FunctionParserUtils.h.

◆ _evalerror_behavior

enum FunctionParserUtils::FailureMethod FunctionParserUtils< is_ad >::_evalerror_behavior

protectedinherited

◆ _func_level_set

SymFunctionPtr LevelSetMeshingHelper::_func_level_set

protected

function parser object describing the level set

Definition at line 31 of file LevelSetMeshingHelper.h.

Referenced by Boundary2DDelaunayGenerator::General2DDelaunay(), SurfaceSubdomainsDelaunayRemesher::General2DDelaunay(), levelSetEvaluator(), and LevelSetMeshingHelper().

◆ _func_params

std::vector<GenericReal<is_ad> > FunctionParserUtils< is_ad >::_func_params

protectedinherited

Array to stage the parameters passed to the functions when calling Eval.

Definition at line 125 of file FunctionParserUtils.h.

Referenced by ArrayParsedAux::ArrayParsedAux(), ParsedSubdomainIDsGenerator::assignElemSubdomainID(), ParsedSubdomainMeshGenerator::assignElemSubdomainID(), ParsedVectorAux::computeValue(), ArrayParsedAux::computeValue(), ParsedAux::computeValue(), CutMeshByLevelSetGenerator::CutMeshByLevelSetGenerator(), CutMeshByPlaneGenerator::CutMeshByPlaneGenerator(), ParsedScalarReporter::finalize(), ParsedVectorRealReductionReporter::finalize(), ParsedVectorReporter::finalize(), ParsedVectorVectorRealReductionReporter::finalize(), ParsedPostprocessor::finalize(), ParsedSubdomainGeneratorBase::functionInitialize(), ParsedExtraElementIDGenerator::generate(), ParsedGenerateNodeset::generate(), ParsedCurveGenerator::generate(), ParsedNodeTransformGenerator::generate(), ParsedGenerateSideset::generate(), ParsedDownSelectionPositions::initialize(), ProjectSideSetOntoLevelSetGenerator::levelSetEvaluator(), CutMeshByLevelSetGeneratorBase::levelSetEvaluator(), LevelSetMeshingHelper(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedElementDeletionGenerator::ParsedElementDeletionGenerator(), ParsedExtraElementIDGenerator::ParsedExtraElementIDGenerator(), ParsedGenerateNodeset::ParsedGenerateNodeset(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedNodeTransformGenerator::ParsedNodeTransformGenerator(), ParsedODEKernel::ParsedODEKernel(), ParsedPostprocessor::ParsedPostprocessor(), ParsedReporterBase::ParsedReporterBase(), ParsedCurveGenerator::pointCalculator(), ProjectSideSetOntoLevelSetGenerator::ProjectSideSetOntoLevelSetGenerator(), ParsedElementDeletionGenerator::shouldDelete(), SolutionUserObject::solutionSampleTime(), SolutionUserObject::SolutionUserObject(), TransfiniteMeshGenerator::TransfiniteMeshGenerator(), and ParsedODEKernel::updateParams().

◆ _max_level_set_correction_iterations

const unsigned int LevelSetMeshingHelper::_max_level_set_correction_iterations

protected

Maximum number of iterations to correct the nodes based on the level set function.

Definition at line 28 of file LevelSetMeshingHelper.h.

Referenced by Boundary2DDelaunayGenerator::General2DDelaunay(), and SurfaceSubdomainsDelaunayRemesher::General2DDelaunay().

◆ _quiet_nan

const Real FunctionParserUtils< is_ad >::_quiet_nan

protectedinherited

appropriate not a number value to return

Definition at line 119 of file FunctionParserUtils.h.

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

include/meshgenerators/LevelSetMeshingHelper.h
src/meshgenerators/LevelSetMeshingHelper.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ SymFunction

◆ SymFunctionPtr

Member Enumeration Documentation

◆ FailureMethod

Constructor & Destructor Documentation

◆ LevelSetMeshingHelper()

Member Function Documentation

◆ addFParserConstants()

◆ evaluate() [1/2]

◆ evaluate() [2/2]

◆ functionsOptimize() [1/3]

◆ functionsOptimize() [2/3]

◆ functionsOptimize() [3/3]

◆ levelSetCorrection()

◆ levelSetEvaluator()

◆ parsedFunctionSetup()

◆ setParserFeatureFlags()

◆ validParams()

Member Data Documentation

◆ _disable_fpoptimizer

◆ _enable_ad_cache

◆ _enable_auto_optimize

◆ _enable_jit

◆ _epsilon

◆ _eval_error_msg

◆ _evalerror_behavior

◆ _func_level_set

◆ _func_params

◆ _max_level_set_correction_iterations

◆ _quiet_nan