#include <Boundary2DDelaunayGenerator.h>

Inheritance diagram for Boundary2DDelaunayGenerator:

Public Types
using	DataFileParameterType = DataFileName
	The parameter type this interface expects for a data file name. More...

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
	Boundary2DDelaunayGenerator (const InputParameters &parameters)

virtual std::unique_ptr< MeshBase >	generate () override
	Generate / modify the mesh. More...

bool	hasGenerateData () const

std::unique_ptr< MeshBase >	generateInternal ()
	Internal generation method - this is what is actually called within MooseApp to execute the MeshGenerator. More...

const std::set< MeshGeneratorName > &	getRequestedMeshGenerators () const

const std::set< MeshGeneratorName > &	getRequestedMeshGeneratorsForSub () const

void	addParentMeshGenerator (const MeshGenerator &mg, const AddParentChildKey)
	Adds the MeshGenerator `mg` as a parent. More...

void	addChildMeshGenerator (const MeshGenerator &mg, const AddParentChildKey)
	Adds the MeshGenerator `mg` as a child. More...

const std::set< const MeshGenerator *, Comparator > &	getParentMeshGenerators () const
	Gets the MeshGenerators that are parents to this MeshGenerator. More...

const std::set< const MeshGenerator *, Comparator > &	getChildMeshGenerators () const
	Gets the MeshGenerators that are children to this MeshGenerator. More...

const std::set< const MeshGenerator *, Comparator > &	getSubMeshGenerators () const
	Gets the MeshGenerators that are children to this MeshGenerator. More...

bool	isParentMeshGenerator (const MeshGeneratorName &name, const bool direct=true) const

bool	isChildMeshGenerator (const MeshGeneratorName &name, const bool direct=true) const

bool	isNullMeshName (const MeshGeneratorName &name) const

bool	hasSaveMesh () const
	Return whether or not to save the current mesh. More...

bool	hasOutput () const

const std::string &	getSavedMeshName () const
	Return the name of the saved mesh. More...

bool	isDataOnly () const

virtual bool	enabled () const
	Return the enabled status of the object. More...

std::shared_ptr< MooseObject >	getSharedPtr ()
	Get another shared pointer to this object that has the same ownership group. More...

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () const
	Get the MooseApp this class is associated with. More...

const std::string &	type () const
	Get the type of this class. More...

const std::string &	name () const
	Get the name of the class. More...

std::string	typeAndName () const
	Get the class's combined type and name; useful in error handling. More...

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const
	Get the parameters of the object. More...

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

template<typename T >
const T &	getParam (const std::string &name) const
	Retrieve a parameter for the object. More...

template<typename T1 , typename T2 >
std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const
	Retrieve two parameters and provide pair of parameters for the object. More...

template<typename T >
const T *	queryParam (const std::string &name) const
	Query a parameter for the object. More...

template<typename T >
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
	Retrieve a renamed parameter for the object. More...

template<typename T >
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
	Verifies that the requested parameter exists and is not NULL and returns it to the caller. More...

bool	isParamValid (const std::string &name) const
	Test if the supplied parameter is valid. More...

bool	isParamSetByUser (const std::string &name) const
	Test if the supplied parameter is set by a user, as opposed to not set or set to default. More...

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
	Connect controllable parameter of this action with the controllable parameters of the objects added by this action. More...

template<typename... Args>
void	paramError (const std::string &param, Args... args) const
	Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramWarning (const std::string &param, Args... args) const
	Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramInfo (const std::string &param, Args... args) const
	Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const
	Deprecated message prefix; the error type is no longer used. More...

template<typename... Args>
void	mooseError (Args &&... args) const
	Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available. More...

template<typename... Args>
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

template<typename... Args>
void	mooseErrorNonPrefixed (Args &&... args) const
	Emits an error without the prefixing included in mooseError(). More...

template<typename... Args>
void	mooseWarning (Args &&... args) const
	Emits a warning prefixed with object name and type. More...

template<typename... Args>
void	mooseWarningNonPrefixed (Args &&... args) const
	Emits a warning without the prefixing included in mooseWarning(). More...

template<typename... Args>
void	mooseDeprecated (Args &&... args) const

template<typename... Args>
void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) const
	External method for calling moose error with added object context. More...

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

std::string	getDataFileName (const std::string &param) const
	Deprecated method. More...

std::string	getDataFileNameByName (const std::string &relative_path) const
	Deprecated method. More...

std::string	getDataFilePath (const std::string &relative_path) const
	Returns the path of a data file for a given relative file path. More...

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

Static Public Member Functions
static InputParameters	validParams ()

static void	setHasGenerateData (InputParameters &params)
	Sets that a mesh generator has a generateData() implementation. More...

static bool	hasGenerateData (const InputParameters &params)

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node)
	External method for calling moose error with added object context. More...

Public Attributes
const ConsoleStream	_console
	An instance of helper class to write streams to the Console objects. More...

Static Public Attributes
static const std::string	data_only_param = "_data_only"
	The name of the private parameter for setting data only. More...

static const std::string	type_param = "_type"
	The name of the parameter that contains the object type. More...

static const std::string	name_param = "_object_name"
	The name of the parameter that contains the object name. More...

static const std::string	unique_name_param = "_unique_name"
	The name of the parameter that contains the unique object name. More...

static const std::string	app_param = "_moose_app"
	The name of the parameter that contains the MooseApp. More...

static const std::string	moose_base_param = "_moose_base"
	The name of the parameter that contains the moose system base. More...

static constexpr auto	SYSTEM = "MeshMetaData"
	The system name used when initializing the Restartable interface. More...

static constexpr auto	NAME = "<empty>"
	The data name used when initializing the Restartable interface for non-MeshGenerator objects. More...

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

Protected Member Functions
Point	elemNormal (const Elem &elem)
	Calculate the normal vector of a 2D element based the first three vertices. More...

Point	meshNormal2D (const MeshBase &mesh)
	Calculate the average normal vector of a 2D mesh based on the normal vectors of its elements using the element areas as weights. More...

Real	meshNormalDeviation2D (const MeshBase &mesh, const Point &global_norm)
	Calculate the maximum deviation of the normal vectors in a given mesh from a global average normal vector. More...

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...

std::unique_ptr< MeshBase >	General2DDelaunay (std::unique_ptr< MeshBase > &mesh_2d, std::vector< std::unique_ptr< MeshBase >> &hole_meshes_2d)
	Generate a 2D mesh using Delaunay triangulation based on the input 2D boundary mesh and the 2D hole meshes. More...

virtual void	generateData ()
	Generate the mesh data. More...

template<typename T >
T &	copyMeshProperty (const std::string &target_data_name, const std::string &source_data_name, const std::string &source_mesh)
	Method for copying attribute from input mesh meta-data store to current mesh meta-data store. More...

template<typename T >
T &	copyMeshProperty (const std::string &source_data_name, const std::string &source_mesh)
	Method for copying attribute from input mesh meta-data store to current mesh meta-data store, keeping source and target data names the same. More...

std::unique_ptr< MeshBase > &	getMesh (const std::string &param_name, const bool allow_invalid=false)
	Takes the name of a MeshGeneratorName parameter and then gets a pointer to the Mesh that MeshGenerator is going to create. More...

std::vector< std::unique_ptr< MeshBase > * >	getMeshes (const std::string &param_name)
	Like getMesh(), but for multiple generators. More...

std::unique_ptr< MeshBase > &	getMeshByName (const MeshGeneratorName &mesh_generator_name)
	Like `getMesh()`, but takes the name of another MeshGenerator directly. More...

std::vector< std::unique_ptr< MeshBase > * >	getMeshesByName (const std::vector< MeshGeneratorName > &mesh_generator_names)
	Like getMeshByName(), but for multiple generators. More...

void	declareMeshForSub (const std::string &param_name)
	Declares that a MeshGenerator referenced in the InputParameters is to be used as a dependency of a sub MeshGenerator created by this MeshGenerator (see addSubMeshGenerator) More...

void	declareMeshesForSub (const std::string &param_name)
	Like declareMeshForSub(), but for multiple generators. More...

void	declareMeshForSubByName (const MeshGeneratorName &mesh_generator_name)
	Like declareMeshForSub(), but takes the name of another MeshGenerator directly. More...

void	declareMeshesForSubByName (const std::vector< MeshGeneratorName > &mesh_generator_names)
	Like declareMeshForSubByName(), but for multiple generators. More...

std::unique_ptr< MeshBase >	buildMeshBaseObject (unsigned int dim=libMesh::invalid_uint)
	Build a `MeshBase` object whose underlying type will be determined by the Mesh input file block. More...

std::unique_ptr< ReplicatedMesh >	buildReplicatedMesh (unsigned int dim=libMesh::invalid_uint)
	Build a replicated mesh. More...

std::unique_ptr< DistributedMesh >	buildDistributedMesh (unsigned int dim=libMesh::invalid_uint)
	Build a distributed mesh that has correct remote element removal behavior and geometric ghosting functors based on the simulation objects. More...

template<typename... Ts>
void	addMeshSubgenerator (const std::string &type, const std::string &name, Ts... extra_input_parameters)
	Construct a "subgenerator", a different MeshGenerator subclass that will be added to the same MooseApp on the fly. More...

void	addMeshSubgenerator (const std::string &type, const std::string &name, InputParameters params)
	Construct a "subgenerator", as above. More...

void	declareNullMeshName (const MeshGeneratorName &name)
	Registers the name `name` as a "null" mesh, which is a MeshGenerator used in InputParameters that will not represent an input mesh when requested via getMesh. More...

template<typename T >
const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)
	Method for retrieving a property with the given type and name exists in the mesh meta-data store. More...

template<typename T >
const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

template<typename T >
bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

template<typename T >
bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

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...


template<typename T , typename... Args>
T &	declareMeshProperty (const std::string &data_name, Args &&... args)
	Methods for writing out attributes to the mesh meta-data store, which can be retrieved from most other MOOSE systems and is recoverable. More...

template<typename T >
T &	declareMeshProperty (const std::string &data_name, const T &data_value)


template<typename T , typename... Args>
T &	setMeshProperty (const std::string &data_name, Args &&... args)
	Method for updating attributes to the mesh meta-data store, which can only be invoked in the MeshGenerator generate routine only if the mesh generator property has already been declared. More...

template<typename T >
T &	setMeshProperty (const std::string &data_name, const T &data_value)

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
std::unique_ptr< MeshBase > &	_input
	The input mesh name. More...

const std::vector< BoundaryName >	_boundary_names
	The boundaries to be converted to a 2D mesh. More...

const std::vector< std::vector< BoundaryName > >	_hole_boundary_names
	The boundaries to be used as holes. More...

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

const Real	_max_angle_deviation
	Max angle deviation from the global average normal vector in the input mesh. More...

BoundaryName	_output_external_boundary_name
	The name of the external boundary of the mesh to generate. More...

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

const bool	_use_auto_area_func
	Whether to use automatic desired area function. More...

const Real	_auto_area_func_default_size
	Background size for automatic desired area function. More...

const Real	_auto_area_func_default_size_dist
	Background size's effective distance for automatic desired area function. More...

const unsigned int	_auto_area_function_num_points
	Maximum number of points to use for the inverse distance interpolation for automatic area function. More...

const Real	_auto_area_function_power
	Power of the polynomial used in the inverse distance interpolation for automatic area function. More...

MooseMesh *const	_mesh
	Pointer to the owning mesh. More...

const bool &	_enabled
	Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects. More...

MooseApp &	_app
	The MOOSE application this is associated with. More...

Factory &	_factory
	The Factory associated with the MooseApp. More...

ActionFactory &	_action_factory
	Builds Actions. More...

const std::string &	_type
	The type of this class. More...

const std::string &	_name
	The name of this class. More...

const InputParameters &	_pars
	The object's parameters. More...

const Parallel::Communicator &	_communicator

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

Definition at line 17 of file Boundary2DDelaunayGenerator.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

The parameter type this interface expects for a data file name.

Definition at line 27 of file DataFileInterface.h.

◆ 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

◆ Boundary2DDelaunayGenerator()

Boundary2DDelaunayGenerator::Boundary2DDelaunayGenerator ( const InputParameters & parameters )

Definition at line 63 of file Boundary2DDelaunayGenerator.C.

   : SurfaceDelaunayGeneratorBase(parameters),
     FunctionParserUtils<false>(parameters),
     _input(getMesh("input")),
     _boundary_names(getParam<std::vector<BoundaryName>>("boundary_names")),
     _hole_boundary_names(getParam<std::vector<std::vector<BoundaryName>>>("hole_boundary_names")),
     _max_level_set_correction_iterations(
         getParam<unsigned int>("max_level_set_correction_iterations")),
     _max_angle_deviation(getParam<Real>("max_angle_deviation")),
     _output_external_boundary_name(getParam<BoundaryName>("output_external_boundary_name"))
 {
   if (isParamValid("level_set"))
   {
     _func_level_set = std::make_shared<SymFunction>();
     // set FParser internal feature flags
     setParserFeatureFlags(_func_level_set);
     if (isParamValid("constant_names") && isParamValid("constant_expressions"))
       addFParserConstants(_func_level_set,
                           getParam<std::vector<std::string>>("constant_names"),
                           getParam<std::vector<std::string>>("constant_expressions"));
     if (_func_level_set->Parse(getParam<std::string>("level_set"), "x,y,z") >= 0)
       mooseError("Invalid function f(x,y,z)\n",
                  _func_level_set,
                  "\nin CutMeshByLevelSetGenerator ",
                  name(),
                  ".\n",
                  _func_level_set->ErrorMsg());
 
     _func_params.resize(3);
   }
 }

Member Function Documentation

◆ addChildMeshGenerator()

void MeshGenerator::addChildMeshGenerator	(	const MeshGenerator &	mg,
		const AddParentChildKey
	)

inherited

Adds the MeshGenerator mg as a child.

Protected by the AddParentChildKey so that parents can only be added by the MooseApp.

Definition at line 365 of file MeshGenerator.C.

 {
   mooseAssert(_app.constructingMeshGenerators(), "Should only be called at construction");
   _child_mesh_generators.insert(&mg);
 }

◆ 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 151 of file FunctionParserUtils.C.

Referenced by Boundary2DDelaunayGenerator(), 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");
   }
 }

◆ addMeshSubgenerator() [1/2]

template<typename... Ts>

void MeshGenerator::addMeshSubgenerator	(	const std::string &	type,
		const std::string &	name,
		Ts...	extra_input_parameters
	)

protectedinherited

Construct a "subgenerator", a different MeshGenerator subclass that will be added to the same MooseApp on the fly.

Parameters

type	The type of MeshGenerator
name	The name of the MeshGenerator
extra_input_parameters	... Additional InputParameters to pass

Sub generators must be added in the order that they are executed.

Any input dependencies for a sub generator that come from inputs for this generator must first be declared with the declareMesh(es)ForSub() method.

You can use the output of a sub generator as a mesh in this generator by calling getMesh() with the sub generator's name after adding said sub generator.

Definition at line 513 of file MeshGenerator.h.

Referenced by OverlayMeshGenerator::OverlayMeshGenerator(), and SideSetExtruderGenerator::SideSetExtruderGenerator().

 {
   InputParameters subgenerator_params = _app.getFactory().getValidParams(type);
 
   subgenerator_params.setParameters(extra_input_parameters...);
 
   addMeshSubgenerator(type, name, subgenerator_params);
 }

◆ addMeshSubgenerator() [2/2]

void MeshGenerator::addMeshSubgenerator	(	const std::string &	type,
		const std::string &	name,
		InputParameters	params
	)

protectedinherited

Construct a "subgenerator", as above.

User code is responsible for constructing valid InputParameters.

Parameters

type	The type of MeshGenerator
name	The name of the MeshGenerator
params	The parameters to use to construct the MeshGenerator

Definition at line 334 of file MeshGenerator.C.

 {
   if (!_app.constructingMeshGenerators())
     mooseError("Can only call addMeshSubgenerator() during MeshGenerator construction");
 
   // In case the user forgot it
   params.set<MooseApp *>(MooseBase::app_param) = &_app;
 
   // Set this to be data-only if this generator is data only
   params.set<bool>(data_only_param) = isDataOnly();
 
   _app.addMeshGenerator(type, name, params);
   _sub_mesh_generators.insert(&std::as_const(_app).getMeshGenerator(name));
 }

◆ addParentMeshGenerator()

void MeshGenerator::addParentMeshGenerator	(	const MeshGenerator &	mg,
		const AddParentChildKey
	)

inherited

Adds the MeshGenerator mg as a parent.

Protected by the AddParentChildKey so that parents can only be added by the MooseApp.

Definition at line 358 of file MeshGenerator.C.

 {
   mooseAssert(_app.constructingMeshGenerators(), "Should only be called at construction");
   _parent_mesh_generators.insert(&mg);
 }

◆ buildDistributedMesh()

std::unique_ptr< DistributedMesh > MeshGenerator::buildDistributedMesh ( unsigned int dim = libMesh::invalid_uint )

protectedinherited

Build a distributed mesh that has correct remote element removal behavior and geometric ghosting functors based on the simulation objects.

Parameters

dim	The logical dimension of the mesh, e.g. 3 for hexes/tets, 2 for quads/tris. If the caller doesn't specify a value for `dim`, then the value in the `Mesh` input file block will be used

Definition at line 253 of file MeshGenerator.C.

Referenced by DistributedRectilinearMeshGenerator::generate().

 {
   mooseAssert(_mesh, "Need a MooseMesh object");
   return _mesh->buildTypedMesh<DistributedMesh>(dim);
 }

◆ buildMeshBaseObject()

std::unique_ptr< MeshBase > MeshGenerator::buildMeshBaseObject ( unsigned int dim = libMesh::invalid_uint )

protectedinherited

Build a MeshBase object whose underlying type will be determined by the Mesh input file block.

Parameters

dim	The logical dimension of the mesh, e.g. 3 for hexes/tets, 2 for quads/tris. If the caller doesn't specify a value for `dim`, then the value in the `Mesh` input file block will be used

Definition at line 239 of file MeshGenerator.C.

Referenced by General2DDelaunay(), BlockToMeshConverterGenerator::generate(), FileMeshGenerator::generate(), ElementGenerator::generate(), SphereMeshGenerator::generate(), GeneratedMeshGenerator::generate(), CartesianMeshGenerator::generate(), ExamplePatchMeshGenerator::generate(), AnnularMeshGenerator::generate(), generate(), PolyLineMeshGenerator::generate(), AdvancedExtruderGenerator::generate(), MeshExtruderGenerator::generate(), and TransfiniteMeshGenerator::generate().

 {
   mooseAssert(_mesh, "Need a MooseMesh object");
   return _mesh->buildMeshBaseObject(dim);
 }

◆ buildReplicatedMesh()

std::unique_ptr< ReplicatedMesh > MeshGenerator::buildReplicatedMesh ( unsigned int dim = libMesh::invalid_uint )

protectedinherited

Build a replicated mesh.

Parameters

dim	The logical dimension of the mesh, e.g. 3 for hexes/tets, 2 for quads/tris. If the caller doesn't specify a value for `dim`, then the value in the `Mesh` input file block will be used

Definition at line 246 of file MeshGenerator.C.

Referenced by FillBetweenCurvesGenerator::generate(), FillBetweenSidesetsGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), ConcentricCircleMeshGenerator::generate(), ImageMeshGenerator::generate(), ParsedCurveGenerator::generate(), SpiralAnnularMeshGenerator::generate(), and RinglebMeshGenerator::generate().

 {
   mooseAssert(_mesh, "Need a MooseMesh object");
   return _mesh->buildTypedMesh<ReplicatedMesh>(dim);
 }

◆ callMooseError() [1/2]

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node = `nullptr`
	)		const

inherited

External method for calling moose error with added object context.

Parameters

msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix

Definition at line 102 of file MooseBase.C.

Referenced by InputParameters::callMooseError(), MooseBase::mooseDocumentedError(), MooseBase::mooseError(), and MooseBase::mooseErrorNonPrefixed().

 {
   callMooseError(&_app, _pars, msg, with_prefix, node);
 }

◆ callMooseError() [2/2]

void MooseBase::callMooseError	(	MooseApp *const	app,
		const InputParameters &	params,
		std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node
	)

staticinherited

External method for calling moose error with added object context.

Needed so that objects without the MooseBase context (InputParameters) can call errors with context

Parameters

app	The app pointer (if available); adds multiapp context and clears the console
params	The parameters, needed to obtain object information
msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix

Definition at line 110 of file MooseBase.C.

 {
   if (!node)
     node = MooseBase::getHitNode(params);
 
   std::string multiapp_prefix = "";
   if (app)
   {
     if (!app->isUltimateMaster())
       multiapp_prefix = app->name();
     app->getOutputWarehouse().mooseConsole();
   }
 
   if (with_prefix)
     // False here because the hit context will get processed by the node
     msg = messagePrefix(params, false) + msg;
 
   moose::internal::mooseErrorRaw(msg, multiapp_prefix, node);
 }

◆ connectControllableParams()

void MooseBase::connectControllableParams	(	const std::string &	parameter,
		const std::string &	object_type,
		const std::string &	object_name,
		const std::string &	object_parameter
	)		const

inherited

Connect controllable parameter of this action with the controllable parameters of the objects added by this action.

Parameters

parameter	Name of the controllable parameter of this action
object_type	Type of the object added by this action.
object_name	Name of the object added by this action.
object_parameter	Name of the parameter of the object.

Definition at line 74 of file MooseBase.C.

 {
   auto & factory = _app.getFactory();
   auto & ip_warehouse = _app.getInputParameterWarehouse();
 
   MooseObjectParameterName primary_name(uniqueName(), parameter);
   const auto base_type = factory.getValidParams(object_type).getBase();
   MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
   ip_warehouse.addControllableParameterConnection(primary_name, secondary_name);
 
   const auto & tags = _pars.get<std::vector<std::string>>("control_tags");
   for (const auto & tag : tags)
   {
     if (!tag.empty())
     {
       // Only adds the parameter with the different control tags if the derived class
       // properly registers the parameter to its own syntax
       MooseObjectParameterName tagged_name(tag, name(), parameter);
       ip_warehouse.addControllableParameterConnection(
           tagged_name, secondary_name, /*error_on_empty=*/false);
     }
   }
 }

◆ copyMeshProperty() [1/2]

template<typename T >

T& MeshGenerator::copyMeshProperty	(	const std::string &	target_data_name,
		const std::string &	source_data_name,
		const std::string &	source_mesh
	)

inlineprotectedinherited

Method for copying attribute from input mesh meta-data store to current mesh meta-data store.

This may often be avoided as getMeshProperty calls can traverse the tree of mesh generators to find a metadata instance

Definition at line 233 of file MeshGenerator.h.

   {
     return declareMeshProperty(target_data_name, getMeshProperty<T>(source_data_name, source_mesh));
   }

◆ copyMeshProperty() [2/2]

template<typename T >

T& MeshGenerator::copyMeshProperty	(	const std::string &	source_data_name,
		const std::string &	source_mesh
	)

inlineprotectedinherited

Method for copying attribute from input mesh meta-data store to current mesh meta-data store, keeping source and target data names the same.

This may often be avoided as getMeshProperty calls can traverse the tree of mesh generators to find a metadata instance

Definition at line 246 of file MeshGenerator.h.

   {
     return copyMeshProperty<T>(source_data_name, source_data_name, source_mesh);
   }

◆ declareMeshesForSub()

void MeshGenerator::declareMeshesForSub ( const std::string & param_name )

protectedinherited

Like declareMeshForSub(), but for multiple generators.

Definition at line 215 of file MeshGenerator.C.

 {
   declareMeshesForSubByName(getMeshGeneratorNamesFromParam(param_name));
 }

◆ declareMeshesForSubByName()

void MeshGenerator::declareMeshesForSubByName ( const std::vector< MeshGeneratorName > & mesh_generator_names )

protectedinherited

Like declareMeshForSubByName(), but for multiple generators.

Definition at line 231 of file MeshGenerator.C.

Referenced by MeshGenerator::declareMeshesForSub().

 {
   for (const auto & name : mesh_generator_names)
     declareMeshForSubByName(name);
 }

◆ declareMeshForSub()

void MeshGenerator::declareMeshForSub ( const std::string & param_name )

protectedinherited

Declares that a MeshGenerator referenced in the InputParameters is to be used as a dependency of a sub MeshGenerator created by this MeshGenerator (see addSubMeshGenerator)

You must declare all such MeshGenerators that are passed by parameter to this MeshGenerator but instead used in a sub MeshGenerator. This is in order to declare the intention to use an input mesh as a dependency for a sub generator instead of this one.

Definition at line 209 of file MeshGenerator.C.

Referenced by OverlayMeshGenerator::OverlayMeshGenerator(), and SideSetExtruderGenerator::SideSetExtruderGenerator().

 {
   declareMeshForSubByName(*getMeshGeneratorNameFromParam(param_name, false));
 }

◆ declareMeshForSubByName()

void MeshGenerator::declareMeshForSubByName ( const MeshGeneratorName & mesh_generator_name )

protectedinherited

Like declareMeshForSub(), but takes the name of another MeshGenerator directly.

Definition at line 221 of file MeshGenerator.C.

Referenced by MeshGenerator::declareMeshesForSubByName(), and MeshGenerator::declareMeshForSub().

 {
   checkGetMesh(mesh_generator_name, "");
   if (isNullMeshName(mesh_generator_name))
     return;
 
   _requested_mesh_generators_for_sub.insert(mesh_generator_name);
 }

◆ declareMeshProperty() [1/2]

template<typename T , typename... Args>

T & MeshGenerator::declareMeshProperty	(	const std::string &	data_name,
		Args &&...	args
	)

protectedinherited

Methods for writing out attributes to the mesh meta-data store, which can be retrieved from most other MOOSE systems and is recoverable.

Definition at line 455 of file MeshGenerator.h.

Referenced by AddMetaDataGenerator::AddMetaDataGenerator(), ConcentricCircleMeshGenerator::ConcentricCircleMeshGenerator(), MeshGenerator::copyMeshProperty(), DistributedRectilinearMeshGenerator::DistributedRectilinearMeshGenerator(), ImageMeshGenerator::ImageMeshGenerator(), RinglebMeshGenerator::RinglebMeshGenerator(), and SpiralAnnularMeshGenerator::SpiralAnnularMeshGenerator().

 {
   if (!_app.constructingMeshGenerators())
     mooseError("Can only call declareMeshProperty() during MeshGenerator construction");
 
   // We sort construction ordering so that we _must_ declare before retrieving
   if (hasMeshProperty(data_name))
     mooseError("While declaring mesh property '",
                data_name,
                "' with type '",
                MooseUtils::prettyCppType<T>(),
                "',\nsaid property has already been declared with type '",
                setMeshPropertyHelper(data_name).type(),
                "'");
 
   const auto full_name = meshPropertyName(data_name);
   auto new_T_value =
       std::make_unique<RestartableData<T>>(full_name, nullptr, std::forward<Args>(args)...);
   auto value =
       &_app.registerRestartableData(std::move(new_T_value), 0, false, MooseApp::MESH_META_DATA);
   mooseAssert(value->declared(), "Should be declared");
 
   RestartableData<T> * T_value = dynamic_cast<RestartableData<T> *>(value);
   mooseAssert(T_value, "Bad cast");
 
   return T_value->set();
 }

◆ declareMeshProperty() [2/2]

template<typename T >

T& MeshGenerator::declareMeshProperty	(	const std::string &	data_name,
		const T &	data_value
	)

inlineprotectedinherited

Definition at line 206 of file MeshGenerator.h.

   {
     return declareMeshProperty<T, const T &>(data_name, data_value);
   }

◆ declareNullMeshName()

void MeshGenerator::declareNullMeshName ( const MeshGeneratorName & name )

protectedinherited

Registers the name name as a "null" mesh, which is a MeshGenerator used in InputParameters that will not represent an input mesh when requested via getMesh.

An example use case for this is when you as a developer want users to represent a hole in a mesh pattern that is defined in input.

Definition at line 398 of file MeshGenerator.C.

 {
   mooseAssert(_app.constructingMeshGenerators(), "Should only be called at construction");
   mooseAssert(!_null_mesh_names.count(name), "Already declared");
   _null_mesh_names.insert(name);
 }

◆ elemNormal()

Point Boundary2DDelaunayGenerator::elemNormal ( const Elem & elem )

protected

Calculate the normal vector of a 2D element based the first three vertices.

Parameters

elem	The element for which the normal vector is to be calculated

Returns: the normal vector of the 2D element

Definition at line 153 of file Boundary2DDelaunayGenerator.C.

Referenced by General2DDelaunay(), meshNormal2D(), and meshNormalDeviation2D().

 {
   mooseAssert(elem.n_vertices() == 3 || elem.n_vertices() == 4, "unsupported element type.");
   // Only the first three vertices are used to calculate the normal vector
   const Point & p0 = *elem.node_ptr(0);
   const Point & p1 = *elem.node_ptr(1);
   const Point & p2 = *elem.node_ptr(2);
 
   if (elem.n_vertices() == 4)
   {
     const Point & p3 = *elem.node_ptr(3);
     return ((p2 - p0).cross(p3 - p1)).unit();
   }
 
   return ((p2 - p1).cross(p0 - p1)).unit();
 }

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 39 of file MooseObject.h.

Referenced by EigenKernel::enabled().

39 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects.

Definition: MooseObject.h:50

◆ errorPrefix()

std::string MooseBase::errorPrefix ( const std::string & ) const

inlineinherited

Deprecated message prefix; the error type is no longer used.

Definition at line 260 of file MooseBase.h.

260 { return messagePrefix(); }

MooseBase::messagePrefix

std::string messagePrefix(const bool hit_prefix=true) const

Definition: MooseBase.h:252

◆ 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(), ParsedAux::computeValue(), ParsedVectorAux::computeValue(), ArrayParsedAux::computeValue(), ParsedPostprocessor::finalize(), ParsedExtraElementIDGenerator::generate(), ParsedGenerateNodeset::generate(), ParsedCurveGenerator::generate(), ParsedNodeTransformGenerator::generate(), ParsedGenerateSideset::generate(), ParsedDownSelectionPositions::initialize(), 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.

 {
   // 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 ? (std::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 209 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);
 }

◆ General2DDelaunay()

std::unique_ptr< MeshBase > Boundary2DDelaunayGenerator::General2DDelaunay	(	std::unique_ptr< MeshBase > &	mesh_2d,
		std::vector< std::unique_ptr< MeshBase >> &	hole_meshes_2d
	)

protected

Generate a 2D mesh using Delaunay triangulation based on the input 2D boundary mesh and the 2D hole meshes.

Parameters

mesh_2d	The input 2D boundary mesh
hole_meshes_2d	The 2D hole meshes

Returns: a unique pointer to the generated 2D mesh

Definition at line 231 of file Boundary2DDelaunayGenerator.C.

Referenced by generate().

 {
   // If a level set is provided, we need to check if the nodes in the original 2D mesh match the
   // level set
   if (_func_level_set)
   {
     for (const auto & node : mesh_2d->node_ptr_range())
     {
       if (std::abs(levelSetEvaluator(*node)) > libMesh::TOLERANCE)
       {
         paramError("level_set",
                    "The level set function does not match the nodes in the given boundary of the "
                    "input mesh.");
       }
     }
   }
 
   // Easier to work with a TRI3 mesh
   // all_tri() also prepares the mesh for use
   mesh_2d->prepare_for_use();
   MeshTools::Modification::all_tri(*mesh_2d);
   const auto mesh_2d_ext_bdry = MooseMeshUtils::getNextFreeBoundaryID(*mesh_2d);
   for (const auto & elem : mesh_2d->active_element_ptr_range())
     for (const auto & i_side : elem->side_index_range())
       if (elem->neighbor_ptr(i_side) == nullptr)
         mesh_2d->get_boundary_info().add_side(elem, i_side, mesh_2d_ext_bdry);
 
   // Create a clone of the 2D mesh to be used for the 1D mesh generation
   auto mesh_2d_dummy = dynamic_pointer_cast<MeshBase>(mesh_2d->clone());
   // Generate a new 1D block based on the external boundary
   const auto new_block_id_1d = MooseMeshUtils::getNextFreeSubdomainID(*mesh_2d_dummy);
 
   MooseMeshUtils::createSubdomainFromSidesets(
       mesh_2d_dummy, {std::to_string(mesh_2d_ext_bdry)}, new_block_id_1d, SubdomainName(), type());
 
   // Create a 1D mesh form the 1D block
   auto mesh_1d = buildMeshBaseObject();
   MooseMeshUtils::convertBlockToMesh(mesh_2d_dummy, mesh_1d, {std::to_string(new_block_id_1d)});
   mesh_2d_dummy->clear();
 
   // If we have holes, we need to create a 1D mesh for each hole
   std::vector<std::unique_ptr<MeshBase>> hole_meshes_1d;
   for (auto & hole_mesh_2d : hole_meshes_2d)
   {
     // As we do not need these holes for reverse projection, we do not need to convert them to TRI3
     // meshes, but we still need to create a 1D mesh for each hole
     hole_mesh_2d->find_neighbors();
     const auto hole_mesh_2d_ext_bdry = MooseMeshUtils::getNextFreeBoundaryID(*hole_mesh_2d);
     for (const auto & elem : hole_mesh_2d->active_element_ptr_range())
       for (const auto & i_side : elem->side_index_range())
         if (elem->neighbor_ptr(i_side) == nullptr)
           hole_mesh_2d->get_boundary_info().add_side(elem, i_side, mesh_2d_ext_bdry);
     const auto new_hole_block_id_1d = MooseMeshUtils::getNextFreeSubdomainID(*hole_mesh_2d);
     MooseMeshUtils::createSubdomainFromSidesets(hole_mesh_2d,
                                                 {std::to_string(hole_mesh_2d_ext_bdry)},
                                                 new_hole_block_id_1d,
                                                 SubdomainName(),
                                                 type());
     // Create a 1D mesh form the 1D block
     hole_meshes_1d.push_back(buildMeshBaseObject());
     MooseMeshUtils::convertBlockToMesh(
         hole_mesh_2d, hole_meshes_1d.back(), {std::to_string(new_hole_block_id_1d)});
     hole_mesh_2d->clear();
   }
 
   // Find centroid of the 2D mesh
   const Point centroid = MooseMeshUtils::meshCentroidCalculator(*mesh_2d);
   // calculate an average normal vector of the 2D mesh
   const Point mesh_norm = meshNormal2D(*mesh_2d);
   // Check the deviation of the mesh normal vector from the global average normal vector
   if (meshNormalDeviation2D(*mesh_2d, mesh_norm) > _max_angle_deviation)
     paramError("boundary_names",
                "The normal vector of some elements in the 2D mesh deviates too much from the "
                "global average normal vector. The maximum deviation is " +
                    std::to_string(_max_angle_deviation) +
                    ". Consider dividing the boundary into several parts to "
                    "reduce the angle deviation.");
 
   // Move both 2d and 1d meshes to the centroid of the 2D mesh
   MeshTools::Modification::translate(*mesh_1d, -centroid(0), -centroid(1), -centroid(2));
   MeshTools::Modification::translate(*mesh_2d, -centroid(0), -centroid(1), -centroid(2));
   // Alsop need to translate the 1D hole meshes if applicable
   for (auto & hole_mesh_1d : hole_meshes_1d)
     MeshTools::Modification::translate(*hole_mesh_1d, -centroid(0), -centroid(1), -centroid(2));
 
   // Calculate the Euler angles to rotate the meshes so that the 2D mesh is close to the XY plane
   // (i.e., the normal vector of the 2D mesh is aligned with the Z axis)
   const Real theta = std::acos(mesh_norm(2)) / M_PI * 180.0;
   const Real phi =
       (MooseUtils::absoluteFuzzyLessThan(mesh_norm(2), 1.0) ? std::atan2(mesh_norm(1), mesh_norm(0))
                                                             : 0.0) /
       M_PI * 180.0;
   MeshTools::Modification::rotate(*mesh_1d, 90.0 - phi, theta, 0.0);
   MeshTools::Modification::rotate(*mesh_2d, 90.0 - phi, theta, 0.0);
   // Also rotate the 1D hole meshes if applicable
   for (auto & hole_mesh_1d : hole_meshes_1d)
     MeshTools::Modification::rotate(*hole_mesh_1d, 90.0 - phi, theta, 0.0);
 
   // Clone the 2D mesh to be used for reverse projection later
   auto mesh_2d_xyz = dynamic_pointer_cast<MeshBase>(mesh_2d->clone());
 
   // Project the 2D mesh to the XY plane so that XYDelaunay can be used
   for (const auto & node : mesh_2d->node_ptr_range())
     (*node)(2) = 0;
   // Project the 1D mesh to the XY plane as well
   for (const auto & node : mesh_1d->node_ptr_range())
     (*node)(2) = 0;
   // Also project the 1D hole meshes to the XY plane if applicable
   for (auto & hole_mesh_1d : hole_meshes_1d)
   {
     for (const auto & node : hole_mesh_1d->node_ptr_range())
       (*node)(2) = 0;
   }
 
   std::vector<libMesh::TriangulatorInterface::MeshedHole> meshed_holes;
   std::vector<libMesh::TriangulatorInterface::Hole *> triangulator_hole_ptrs(hole_meshes_1d.size());
   meshed_holes.reserve(hole_meshes_1d.size());
   for (auto hole_i : index_range(hole_meshes_1d))
   {
     hole_meshes_1d[hole_i]->prepare_for_use();
     meshed_holes.emplace_back(*hole_meshes_1d[hole_i]);
     triangulator_hole_ptrs[hole_i] = &meshed_holes.back();
   }
 
   // Finally, triangulation
   std::unique_ptr<UnstructuredMesh> mesh =
       dynamic_pointer_cast<UnstructuredMesh>(std::move(mesh_1d));
 
   Poly2TriTriangulator poly2tri(*mesh);
   poly2tri.triangulation_type() = TriangulatorInterface::PSLG;
 
   poly2tri.set_interpolate_boundary_points(0);
   poly2tri.set_refine_boundary_allowed(false);
   poly2tri.set_verify_hole_boundaries(false);
   poly2tri.desired_area() = 0;
   poly2tri.minimum_angle() = 0; // Not yet supported
   poly2tri.smooth_after_generating() = false;
   if (!triangulator_hole_ptrs.empty())
     poly2tri.attach_hole_list(&triangulator_hole_ptrs);
   // Future TODO: correct the area function based on the local normal vector
   if (_use_auto_area_func)
     poly2tri.set_auto_area_function(this->comm(),
                                     _auto_area_function_num_points,
                                     _auto_area_function_power,
                                     _auto_area_func_default_size,
                                     _auto_area_func_default_size_dist);
   poly2tri.triangulate();
 
   // Reverse the projection based on the original 2D mesh
   for (const auto & node : mesh->node_ptr_range())
   {
     bool node_mod = false;
     // Try to find the element in mesh_2d that contains the new node
     for (const auto & elem : mesh_2d->active_element_ptr_range())
     {
       if (elem->contains_point(Point((*node)(0), (*node)(1), 0.0)))
       {
         // Element id
         const auto elem_id = elem->id();
         // element in xyz_in_xyz
         const Elem & elem_xyz = *mesh_2d_xyz->elem_ptr(elem_id);
 
         const Point elem_normal = elemNormal(elem_xyz);
         const Point & elem_p = *mesh_2d_xyz->elem_ptr(elem_id)->node_ptr(0);
 
         // if the x and y values of the node is the same as the elem_p's first node, we can just
         // move it to that node's position
         if (MooseUtils::absoluteFuzzyEqual((*node)(0), elem_p(0)) &&
             MooseUtils::absoluteFuzzyEqual((*node)(1), elem_p(1)))
         {
           (*node)(2) = elem_p(2);
           node_mod = true;
           break;
         }
         // Otherwise, we need to find a position inside the 2D element
         // It has the same x and y coordinates as the node in the projected mesh;
         (*node)(2) = elem_p(2) - (((*node)(0) - elem_p(0)) * elem_normal(0) +
                                   ((*node)(1) - elem_p(1)) * elem_normal(1)) /
                                      elem_normal(2);
         node_mod = true;
         break;
       }
     }
     if (!node_mod)
       mooseError("Node not found in mesh_in_xy");
   }
 
   // Rotate the mesh back
   MeshTools::Modification::rotate(*mesh, 0.0, -theta, phi - 90.0);
   // Translate the mesh back
   MeshTools::Modification::translate(*mesh, centroid(0), centroid(1), centroid(2));
 
   // Correct the nodes based on the level set function
   if (_func_level_set)
   {
     for (const auto & node : mesh->node_ptr_range())
     {
       unsigned int iter_ct = 0;
       while (iter_ct < _max_level_set_correction_iterations &&
              std::abs(levelSetEvaluator(*node)) > libMesh::TOLERANCE * libMesh::TOLERANCE)
       {
         levelSetCorrection(*node);
         ++iter_ct;
       }
     }
   }
 
   // Assign the external boundary name if provided
   if (!_output_external_boundary_name.empty())
   {
     const std::vector<BoundaryID> output_boundary_id =
         MooseMeshUtils::getBoundaryIDs(*mesh, {_output_external_boundary_name}, true);
 
     libMesh::MeshTools::Modification::change_boundary_id(*mesh, 0, output_boundary_id[0]);
     mesh->get_boundary_info().sideset_name(output_boundary_id[0]) = _output_external_boundary_name;
   }
 
   mesh->set_isnt_prepared();
 
   return mesh;
 }

◆ generate()

std::unique_ptr< MeshBase > Boundary2DDelaunayGenerator::generate ( )

overridevirtual

Generate / modify the mesh.

Implements SurfaceDelaunayGeneratorBase.

Definition at line 96 of file Boundary2DDelaunayGenerator.C.

 {
   std::unique_ptr<MeshBase> mesh_3d = std::move(_input);
 
   // Generate a new 2D block based on the sidesets
   const auto new_block_id = MooseMeshUtils::getNextFreeSubdomainID(*mesh_3d);
   try
   {
     MooseMeshUtils::createSubdomainFromSidesets(
         mesh_3d, _boundary_names, new_block_id, SubdomainName(), type());
   }
   catch (MooseException & e)
   {
     if (((std::string)e.what()).compare(0, 12, "The sideset ") == 0)
       paramError("boundary_names", e.what());
     else
       mooseError(e.what());
   }
 
   // If holes are provided, we need to create new blocks for them too
   std::vector<subdomain_id_type> hole_block_ids;
   for (const auto & hole : _hole_boundary_names)
   {
     hole_block_ids.push_back(MooseMeshUtils::getNextFreeSubdomainID(*mesh_3d));
     try
     {
       MooseMeshUtils::createSubdomainFromSidesets(
           mesh_3d, hole, hole_block_ids.back(), SubdomainName(), type());
     }
     catch (MooseException & e)
     {
       if (((std::string)e.what()).compare(0, 12, "The sideset ") == 0)
         paramError("hole_boundary_names", e.what());
       else
         mooseError(e.what());
     }
   }
 
   // Create a 2D mesh form the 2D block
   auto mesh_2d = buildMeshBaseObject();
   MooseMeshUtils::convertBlockToMesh(mesh_3d, mesh_2d, {std::to_string(new_block_id)});
   // If holes are provided, we need to create a 2D mesh for each hole
   std::vector<std::unique_ptr<MeshBase>> hole_meshes_2d;
   for (const auto & hole_block_id : hole_block_ids)
   {
     hole_meshes_2d.push_back(buildMeshBaseObject());
     MooseMeshUtils::convertBlockToMesh(
         mesh_3d, hole_meshes_2d.back(), {std::to_string(hole_block_id)});
   }
 
   // We do not need the 3D mesh anymore
   mesh_3d->clear();
 
   return General2DDelaunay(mesh_2d, hole_meshes_2d);
 }

◆ generateData()

void MeshGenerator::generateData ( )

protectedvirtualinherited

Generate the mesh data.

Reimplemented in AddMetaDataGenerator.

Definition at line 424 of file MeshGenerator.C.

Referenced by MeshGenerator::generateInternal().

 {
   mooseAssert(!hasGenerateData(), "Inconsistent flag");
   mooseError("This MeshGenerator does not have a generateData() implementation.");
 }

◆ generateInternal()

std::unique_ptr< MeshBase > MeshGenerator::generateInternal ( )

inherited

Internal generation method - this is what is actually called within MooseApp to execute the MeshGenerator.

Definition at line 260 of file MeshGenerator.C.

 {
   libmesh_parallel_only(comm());
   mooseAssert(comm().verify(type() + name()), "Inconsistent execution ordering");
 
   if (hasGenerateData())
     generateData();
 
   if (isDataOnly())
     return nullptr;
 
   auto mesh = generate();
   if (!mesh)
     mooseError("A mesh was not generated by this generator (it was nullptr).");
 
   for (const auto & [requested_name, requested_mesh] : _requested_meshes)
     if (*requested_mesh)
       mooseError(
           "The mesh from input ",
           _app.getMeshGenerator(requested_name).type(),
           " '",
           _app.getMeshGenerator(requested_name).name(),
           "' was not moved.\n\nThe MeshGenerator system requires that the memory from all input "
           "meshes\nare managed by the requesting MeshGenerator during the generate phase.\n\nThis "
           "is achieved with a std::move() operation within the generate() method.");
 
   if (getParam<bool>("show_info"))
   {
     const auto mesh_info = mesh->get_info(/* verbosity = */ 2);
 
     // We will prefix all information with "type() 'name()':" because this could potentially
     // output a ton of information and looks a bit better with a prefix
     std::stringstream oss;
     const auto split = MooseUtils::split(mesh_info, "\n");
     if (split.size())
       for (std::size_t i = 0; i < split.size() - 1; ++i) // ignore the last line break
         oss << COLOR_CYAN << "" << type() << " '" << name() << "': " << COLOR_DEFAULT << split[i]
             << std::endl;
     _console << oss.str() << std::flush;
   }
 
   // output the current mesh block to file
   if (hasOutput())
   {
     if (!mesh->is_prepared())
       mesh->prepare_for_use();
 
     if (!getParam<bool>("nemesis"))
     {
       libMesh::ExodusII_IO exio(*mesh);
 
       if (mesh->mesh_dimension() == 1)
         exio.write_as_dimension(3);
 
       // Default to non-HDF5 output for wider compatibility
       exio.set_hdf5_writing(false);
 
       exio.write(name() + "_in.e");
     }
     else
     {
       libMesh::Nemesis_IO nemesis_io(*mesh);
 
       // Default to non-HDF5 output for wider compatibility
       nemesis_io.set_hdf5_writing(false);
 
       nemesis_io.write(name() + "_in.e");
     }
   }
 
   return mesh;
 }

◆ getBase()

const std::string& MooseBase::getBase ( ) const

inlineinherited

Returns: The registered base for this object (set via InputParameters::registerBase())

Definition at line 143 of file MooseBase.h.

Referenced by Factory::copyConstruct(), and MooseBase::uniqueParameterName().

143 { return _pars.getBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

InputParameters::getBase

const std::string & getBase() const

Definition: InputParameters.C:497

◆ getCheckedPointerParam()

template<typename T >

T MooseBase::getCheckedPointerParam	(	const std::string &	name,
		const std::string &	error_string = `""`
	)		const

inherited

Verifies that the requested parameter exists and is not NULL and returns it to the caller.

The template parameter must be a pointer or an error will be thrown.

Definition at line 428 of file MooseBase.h.

 {
   return _pars.getCheckedPointerParam<T>(name, error_string);
 }

◆ getChildMeshGenerators()

const std::set<const MeshGenerator *, Comparator>& MeshGenerator::getChildMeshGenerators ( ) const

inlineinherited

Gets the MeshGenerators that are children to this MeshGenerator.

Definition at line 129 of file MeshGenerator.h.

Referenced by MeshGenerator::isChildMeshGenerator().

   {
     return _child_mesh_generators;
   }

◆ getDataFileName()

std::string DataFileInterface::getDataFileName ( const std::string & param ) const

inherited

Deprecated method.

The data file paths are now automatically set within the InputParameters object, so using getParam<DataFileName>("param_name") is now sufficient.

Definition at line 21 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileName() is deprecated. The file path is now directly set "
                           "within the InputParameters.\nUse getParam<DataFileName>(\"",
                           param,
                           "\") instead.");
   return _parent.getParam<DataFileName>(param);
 }

◆ getDataFileNameByName()

std::string DataFileInterface::getDataFileNameByName ( const std::string & relative_path ) const

inherited

Deprecated method.

Use getDataFilePath() instead.

Definition at line 31 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileNameByName() is deprecated. Use getDataFilePath(\"",
                           relative_path,
                           "\") instead.");
   return getDataFilePath(relative_path);
 }

◆ getDataFilePath()

std::string DataFileInterface::getDataFilePath ( const std::string & relative_path ) const

inherited

Returns the path of a data file for a given relative file path.

This can be used for hardcoded datafile names and will search the same locations as getDataFileName

Definition at line 40 of file DataFileInterface.C.

Referenced by DataFileInterface::getDataFileNameByName().

 {
   // This should only ever be used with relative paths. There is no point to
   // use this search path with an absolute path.
   if (std::filesystem::path(relative_path).is_absolute())
     _parent.mooseWarning("While using getDataFilePath(\"",
                          relative_path,
                          "\"): This API should not be used for absolute paths.");
 
   // Throw on error so that if getPath() fails, we can throw an error
   // with the context of _parent.mooseError()
   const auto throw_on_error_before = Moose::_throw_on_error;
   Moose::_throw_on_error = true;
   std::optional<std::string> error;
 
   // This will search the data paths for this relative path
   Moose::DataFileUtils::Path found_path;
   try
   {
     found_path = Moose::DataFileUtils::getPath(relative_path);
   }
   catch (std::exception & e)
   {
     error = e.what();
   }
 
   Moose::_throw_on_error = throw_on_error_before;
   if (error)
     _parent.mooseError(*error);
 
   mooseAssert(found_path.context == Moose::DataFileUtils::Context::DATA,
               "Should only ever obtain data");
   mooseAssert(found_path.data_name, "Should be set");
 
   const std::string msg =
       "Using data file '" + found_path.path + "' from " + *found_path.data_name + " data";
   _parent.mooseInfo(msg);
 
   return found_path.path;
 }

◆ getHitNode()

const hit::Node* MooseBase::getHitNode ( ) const

inlineinherited

Returns: The block-level hit node for this object, if any

Definition at line 132 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MooseBase::callMooseError(), MooseBase::getHitNode(), and MooseBase::messagePrefix().

132 { return getHitNode(_pars); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

MooseBase::getHitNode

const hit::Node * getHitNode() const

Definition: MooseBase.h:132

◆ getMesh()

std::unique_ptr< MeshBase > & MeshGenerator::getMesh	(	const std::string &	param_name,
		const bool	allow_invalid = `false`
	)

protectedinherited

Takes the name of a MeshGeneratorName parameter and then gets a pointer to the Mesh that MeshGenerator is going to create.

That MeshGenerator is made to be a dependency of this one, so will generate() its mesh first.

Parameters

param_name	The name of the parameter that contains the name of the MeshGenerator
allow_invalid	If true, will allow for invalid parameters and will return a nullptr mesh if said parameter does not exist

Returns: The Mesh generated by that MeshGenerator

NOTE: You MUST catch this by reference!

Definition at line 172 of file MeshGenerator.C.

 {
   const MeshGeneratorName * name = getMeshGeneratorNameFromParam(param_name, allow_invalid);
   if (!name)
     return _null_mesh;
   return getMeshByName(*name);
 }

◆ getMeshByName()

std::unique_ptr< MeshBase > & MeshGenerator::getMeshByName ( const MeshGeneratorName & mesh_generator_name )

protectedinherited

Like getMesh(), but takes the name of another MeshGenerator directly.

NOTE: You MUST catch this by reference!

Returns: The Mesh generated by that MeshGenerator

Definition at line 187 of file MeshGenerator.C.

Referenced by MeshGenerator::getMesh(), MeshGenerator::getMeshesByName(), OverlayMeshGenerator::OverlayMeshGenerator(), and SideSetExtruderGenerator::SideSetExtruderGenerator().

 {
   checkGetMesh(mesh_generator_name, "");
   if (isNullMeshName(mesh_generator_name))
     return _null_mesh;
 
   _requested_mesh_generators.insert(mesh_generator_name);
   auto & mesh = _app.getMeshGeneratorSystem().getMeshGeneratorOutput(mesh_generator_name);
   _requested_meshes.emplace_back(mesh_generator_name, &mesh);
   return mesh;
 }

◆ getMeshes()

std::vector< std::unique_ptr< MeshBase > * > MeshGenerator::getMeshes ( const std::string & param_name )

protectedinherited

Like getMesh(), but for multiple generators.

Returns: The generated meshes

Definition at line 181 of file MeshGenerator.C.

 {
   return getMeshesByName(getMeshGeneratorNamesFromParam(param_name));
 }

◆ getMeshesByName()

std::vector< std::unique_ptr< MeshBase > * > MeshGenerator::getMeshesByName ( const std::vector< MeshGeneratorName > & mesh_generator_names )

protectedinherited

Like getMeshByName(), but for multiple generators.

Returns: The generated meshes

Definition at line 200 of file MeshGenerator.C.

Referenced by MeshGenerator::getMeshes().

 {
   std::vector<std::unique_ptr<MeshBase> *> meshes;
   for (const auto & name : mesh_generator_names)
     meshes.push_back(&getMeshByName(name));
   return meshes;
 }

◆ getMeshProperty() [1/2]

template<typename T >

const T & MeshMetaDataInterface::getMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)

protectedinherited

Method for retrieving a property with the given type and name exists in the mesh meta-data store.

This method will throw an error if the property does not exist.

Definition at line 134 of file MeshMetaDataInterface.h.

 {
   if (!hasMeshProperty(data_name, prefix))
     mooseErrorInternal("Failed to get mesh property '", prefix, "/", data_name, "'");
 
   auto value = &getMeshPropertyInternal(data_name, prefix);
   mooseAssert(value->declared(), "Value has not been declared");
   const RestartableData<T> * T_value = dynamic_cast<const RestartableData<T> *>(value);
   if (!T_value)
     mooseErrorInternal("While retrieving mesh property '",
                        prefix,
                        "/",
                        data_name,
                        "' with type '",
                        MooseUtils::prettyCppType<T>(),
                        "',\nthe property exists with different type '",
                        value->type(),
                        "'");
   return T_value->get();
 }

◆ getMeshProperty() [2/2]

template<typename T >

const T& MeshMetaDataInterface::getMeshProperty ( const std::string & data_name )

inlineprotectedinherited

Definition at line 56 of file MeshMetaDataInterface.h.

   {
     return getMeshProperty<T>(data_name, meshPropertyPrefix(data_name));
   }

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 83 of file MooseBase.h.

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), AddDefaultConvergenceAction::addDefaultSteadyStateConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedSteadyStateConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), Coupleable::Coupleable(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultConvergenceBase::getSharedExecutionerParam(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), MultiApp::restore(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

83 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:353

◆ getParam() [1/2]

template<typename T >

const T & MooseBase::getParam ( const std::string & name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 384 of file MooseBase.h.

 {
   return InputParameters::getParamHelper<T>(name, _pars);
 }

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBase::getParam	(	const std::string &	param1,
		const std::string &	param2
	)		const

inherited

Retrieve two parameters and provide pair of parameters for the object.

Parameters

param1	The name of first parameter
param2	The name of second parameter

Returns: Vector of pairs of first and second parameters

Definition at line 421 of file MooseBase.h.

 {
   return _pars.get<T1, T2>(param1, param2);
 }

◆ getParentMeshGenerators()

const std::set<const MeshGenerator *, Comparator>& MeshGenerator::getParentMeshGenerators ( ) const

inlineinherited

Gets the MeshGenerators that are parents to this MeshGenerator.

Definition at line 122 of file MeshGenerator.h.

Referenced by MeshGeneratorSystem::createMeshGeneratorOrder(), and MeshGenerator::isParentMeshGenerator().

   {
     return _parent_mesh_generators;
   }

◆ getRenamedParam()

template<typename T >

const T & MooseBase::getRenamedParam	(	const std::string &	old_name,
		const std::string &	new_name
	)		const

inherited

Retrieve a renamed parameter for the object.

This helper makes sure we check both names before erroring, and that only one parameter is passed to avoid silent errors

Parameters

old_name	the old name for the parameter
new_name	the new name for the parameter

Definition at line 398 of file MooseBase.h.

 {
   // Most important: accept new parameter
   if (isParamSetByUser(new_name) && !isParamValid(old_name))
     return getParam<T>(new_name);
   // Second most: accept old parameter
   if (isParamValid(old_name) && !isParamSetByUser(new_name))
     return getParam<T>(old_name);
   // Third most: accept default for new parameter
   if (isParamValid(new_name) && !isParamValid(old_name))
     return getParam<T>(new_name);
   // Refuse: no default, no value passed
   if (!isParamValid(old_name) && !isParamValid(new_name))
     mooseError("parameter '" + new_name +
                "' is being retrieved without being set.\nDid you misspell it?");
   // Refuse: both old and new parameters set by user
   else
     mooseError("Parameter '" + new_name + "' may not be provided alongside former parameter '" +
                old_name + "'");
 }

◆ getRequestedMeshGenerators()

const std::set<MeshGeneratorName>& MeshGenerator::getRequestedMeshGenerators ( ) const

inlineinherited

Returns: The names of the MeshGenerators that were requested in the getMesh methods

Definition at line 80 of file MeshGenerator.h.

   {
     return _requested_mesh_generators;
   }

◆ getRequestedMeshGeneratorsForSub()

const std::set<MeshGeneratorName>& MeshGenerator::getRequestedMeshGeneratorsForSub ( ) const

inlineinherited

Returns: The names of the MeshGenerators that were requested in the declareMeshForSub methods

Definition at line 88 of file MeshGenerator.h.

   {
     return _requested_mesh_generators_for_sub;
   }

◆ getSavedMeshName()

const std::string & MeshGenerator::getSavedMeshName ( ) const

inherited

Return the name of the saved mesh.

Definition at line 418 of file MeshGenerator.C.

 {
   return _save_with_name;
 }

◆ getSharedPtr() [1/2]

std::shared_ptr< MooseObject > MooseObject::getSharedPtr ( )

inherited

Get another shared pointer to this object that has the same ownership group.

Wrapper around shared_from_this().

Definition at line 61 of file MooseObject.C.

Referenced by MFEMProblem::addBoundaryCondition(), MFEMProblem::addKernel(), and MFEMProblem::addMFEMSolver().

 {
   try
   {
     return shared_from_this();
   }
   catch (std::bad_weak_ptr &)
   {
     mooseError(not_shared_error);
   }
 }

◆ getSharedPtr() [2/2]

std::shared_ptr< const MooseObject > MooseObject::getSharedPtr ( ) const

inherited

Definition at line 74 of file MooseObject.C.

 {
   try
   {
     return shared_from_this();
   }
   catch (std::bad_weak_ptr &)
   {
     mooseError(not_shared_error);
   }
 }

◆ getSubMeshGenerators()

const std::set<const MeshGenerator *, Comparator>& MeshGenerator::getSubMeshGenerators ( ) const

inlineinherited

Gets the MeshGenerators that are children to this MeshGenerator.

Definition at line 136 of file MeshGenerator.h.

   {
     return _sub_mesh_generators;
   }

◆ hasBase()

bool MooseBase::hasBase ( ) const

inlineinherited

Returns: Whether or not this object has a registered base (set via InputParameters::registerBase())

Definition at line 138 of file MooseBase.h.

138 { return _pars.hasBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

InputParameters::hasBase

bool hasBase() const

Definition: InputParameters.C:491

◆ hasGenerateData() [1/2]

bool MeshGenerator::hasGenerateData ( const InputParameters & params )

staticinherited

Returns: Whether or not the mesh generator noted by the given parameters has a generateData() implementation

Definition at line 86 of file MeshGenerator.C.

 {
   return params.get<bool>("_has_generate_data");
 }

◆ hasGenerateData() [2/2]

bool MeshGenerator::hasGenerateData ( ) const

inlineinherited

Returns: Whether or not this generator has a generateData() implementation

Definition at line 185 of file MeshGenerator.h.

Referenced by MeshGenerator::generateData(), MeshGenerator::generateInternal(), MeshGenerator::hasGenerateData(), and MeshGenerator::MeshGenerator().

185 { return hasGenerateData(_pars); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

MeshGenerator::hasGenerateData

bool hasGenerateData() const

Definition: MeshGenerator.h:185

◆ hasMeshProperty() [1/4]

bool MeshMetaDataInterface::hasMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)		const

protectedinherited

Returns: Whether or not a mesh meta-data exists.

Definition at line 25 of file MeshMetaDataInterface.C.

Referenced by MeshGenerator::declareMeshProperty(), MeshMetaDataInterface::getMeshProperty(), MeshMetaDataInterface::hasMeshProperty(), and MeshGenerator::setMeshProperty().

 {
   return _meta_data_app.hasRestartableMetaData(meshPropertyName(data_name, prefix),
                                                MooseApp::MESH_META_DATA);
 }

◆ hasMeshProperty() [2/4]

template<typename T >

bool MeshMetaDataInterface::hasMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)		const

protectedinherited

Returns: Whether or not a mesh meta-data exists with the given type.

Definition at line 158 of file MeshMetaDataInterface.h.

 {
   if (!hasMeshProperty(data_name, prefix))
     return false;
   const auto & value = getMeshPropertyInternal(data_name, prefix);
   return dynamic_cast<const RestartableData<T> *>(&value) != nullptr;
 }

◆ hasMeshProperty() [3/4]

bool MeshMetaDataInterface::hasMeshProperty ( const std::string & data_name ) const

inlineprotectedinherited

Returns: Whether or not a mesh meta-data exists with the default prefix.

Definition at line 74 of file MeshMetaDataInterface.h.

   {
     return hasMeshProperty(data_name, meshPropertyPrefix(data_name));
   }

◆ hasMeshProperty() [4/4]

template<typename T >

bool MeshMetaDataInterface::hasMeshProperty ( const std::string & data_name ) const

inlineprotectedinherited

Returns: Whether or not a mesh meta-data exists with the default prefix and the given type.

Definition at line 82 of file MeshMetaDataInterface.h.

   {
     return hasMeshProperty<T>(data_name, meshPropertyPrefix(data_name));
   }

◆ hasOutput()

bool MeshGenerator::hasOutput ( ) const

inherited

Returns: Whether or not to output this mesh generator separately (output parameter is set)

Definition at line 412 of file MeshGenerator.C.

Referenced by MeshGeneratorSystem::createMeshGeneratorOrder(), and MeshGenerator::generateInternal().

 {
   return getParam<bool>("output");
 }

◆ hasSaveMesh()

bool MeshGenerator::hasSaveMesh ( ) const

inherited

Return whether or not to save the current mesh.

Definition at line 406 of file MeshGenerator.C.

Referenced by MeshGeneratorSystem::createMeshGeneratorOrder(), and MeshGenerator::MeshGenerator().

 {
   return _save_with_name.size();
 }

◆ isChildMeshGenerator()

bool MeshGenerator::isChildMeshGenerator	(	const MeshGeneratorName &	name,
		const bool	direct = `true`
	)		const

inherited

Returns: Whether or not the MeshGenerator with the name name is a child of this MeshGenerator.

If direct = true, check only immediate children of this generator. Otherwise, check all children.

Definition at line 385 of file MeshGenerator.C.

Referenced by MeshGeneratorSystem::createMeshGeneratorOrder().

 {
   return std::find_if(getChildMeshGenerators().begin(),
                       getChildMeshGenerators().end(),
                       [&name, &direct](const auto & mg)
                       {
                         return mg->name() == name ||
                                (!direct && mg->isChildMeshGenerator(name, /* direct = */ false));
                       }) != getChildMeshGenerators().end();
 }

◆ isDataOnly()

bool MeshGenerator::isDataOnly ( ) const

inlineinherited

Returns: Whether or not this generator is to be generated in data-only mode

Definition at line 190 of file MeshGenerator.h.

Referenced by MeshGenerator::addMeshSubgenerator(), MeshGenerator::generateInternal(), and MeshGenerator::MeshGenerator().

190 { return _data_only; }

MeshGenerator::_data_only

const bool _data_only

Whether or not this mesh generator will run in data only mode.

Definition: MeshGenerator.h:450

◆ isNullMeshName()

bool MeshGenerator::isNullMeshName ( const MeshGeneratorName & name ) const

inlineinherited

Returns: Whether or not the name name is registered as a "null" mesh, that is, a MeshGenerator that will not represent an input mesh when requested via getMesh.

See declareNullMeshName().

Definition at line 165 of file MeshGenerator.h.

Referenced by MeshGenerator::checkGetMesh(), MeshGenerator::declareMeshForSubByName(), and MeshGenerator::getMeshByName().

165 { return _null_mesh_names.count(name); }

MeshGenerator::_null_mesh_names

std::set< std::string > _null_mesh_names

The declared "null" mesh names that will not represent a mesh in input; see declareNullMeshName() ...

Definition: MeshGenerator.h:444

MooseBase::name

const std::string & name() const

Get the name of the class.

Definition: MooseBase.h:99

◆ isParamSetByUser()

bool MooseBase::isParamSetByUser ( const std::string & name ) const

inlineinherited

Test if the supplied parameter is set by a user, as opposed to not set or set to default.

Parameters

name	The name of the parameter to test

Definition at line 201 of file MooseBase.h.

Referenced by SetupDebugAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), MFEMMesh::buildMesh(), LibtorchNeuralNetControl::conditionalParameterError(), MooseApp::copyInputs(), DiffusionPhysicsBase::DiffusionPhysicsBase(), MooseApp::errorCheck(), MooseBase::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PiecewiseTabularBase::PiecewiseTabularBase(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), PhysicsBase::reportPotentiallyMissedParameters(), MooseApp::runInputFile(), MooseApp::runInputs(), MFEMSolverBase::setPreconditioner(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), TimedSubdomainModifier::TimedSubdomainModifier(), and XYDelaunayGenerator::XYDelaunayGenerator().

   {
     return _pars.isParamSetByUser(name);
   }

◆ isParamValid()

bool MooseBase::isParamValid ( const std::string & name ) const

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 195 of file MooseBase.h.

195 { return _pars.isParamValid(name); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

MooseBase::name

const std::string & name() const

Get the name of the class.

Definition: MooseBase.h:99

InputParameters::isParamValid

bool isParamValid(const std::string &name) const

This method returns parameters that have been initialized in one fashion or another, i.e.

Definition: InputParameters.C:386

◆ isParentMeshGenerator()

bool MeshGenerator::isParentMeshGenerator	(	const MeshGeneratorName &	name,
		const bool	direct = `true`
	)		const

inherited

Returns: Whether or not the MeshGenerator with the name name is a parent of this MeshGenerator.

If direct = true, check only immediate parents of this generator. Otherwise, check all parents.

Definition at line 372 of file MeshGenerator.C.

 {
   return std::find_if(getParentMeshGenerators().begin(),
                       getParentMeshGenerators().end(),
                       [&name, &direct](const auto & mg)
                       {
                         return mg->name() == name ||
                                (!direct && mg->isParentMeshGenerator(name, /* direct = */ false));
                       }) != getParentMeshGenerators().end();
 }

◆ levelSetCorrection()

void Boundary2DDelaunayGenerator::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 210 of file Boundary2DDelaunayGenerator.C.

Referenced by 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 Boundary2DDelaunayGenerator::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 204 of file Boundary2DDelaunayGenerator.C.

Referenced by General2DDelaunay(), and levelSetCorrection().

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

◆ meshNormal2D()

Point Boundary2DDelaunayGenerator::meshNormal2D ( const MeshBase & mesh )

protected

Calculate the average normal vector of a 2D mesh based on the normal vectors of its elements using the element areas as weights.

Parameters

mesh	The mesh for which the average normal vector is to be calculated

Returns: the average normal vector of the 2D mesh

Definition at line 171 of file Boundary2DDelaunayGenerator.C.

Referenced by General2DDelaunay().

 {
   Point mesh_norm = Point(0.0, 0.0, 0.0);
   Real mesh_area = 0.0;
 
   // Check all the elements' normal vectors
   for (const auto & elem : mesh.active_local_element_ptr_range())
   {
     const Real elem_area = elem->volume();
     mesh_norm += elemNormal(*elem) * elem_area;
     mesh_area += elem_area;
   }
   mesh.comm().sum(mesh_norm);
   mesh.comm().sum(mesh_area);
   mesh_norm /= mesh_area;
   return mesh_norm.unit();
 }

◆ meshNormalDeviation2D()

Real Boundary2DDelaunayGenerator::meshNormalDeviation2D	(	const MeshBase &	mesh,
		const Point &	global_norm
	)

protected

Calculate the maximum deviation of the normal vectors in a given mesh from a global average normal vector.

Parameters

mesh	The mesh for which the maximum deviation is to be calculated
global_norm	The global average normal vector

Returns: the maximum deviation of the normal vectors in the mesh from the global average normal in degrees

Definition at line 190 of file Boundary2DDelaunayGenerator.C.

Referenced by General2DDelaunay().

 {
   Real max_deviation(0.0);
   // Check all the elements' deviation from the global normal vector
   for (const auto & elem : mesh.active_local_element_ptr_range())
   {
     const Real elem_deviation = std::acos(global_norm * elemNormal(*elem)) / M_PI * 180.0;
     max_deviation = std::max(max_deviation, elem_deviation);
   }
   mesh.comm().max(max_deviation);
   return max_deviation;
 }

◆ meshPropertyName() [1/2]

std::string MeshMetaDataInterface::meshPropertyName	(	const std::string &	data_name,
		const std::string &	prefix
	)

staticprotectedinherited

Returns: The full name for mesh property data.

Definition at line 33 of file MeshMetaDataInterface.C.

Referenced by MeshGenerator::declareMeshProperty(), MeshMetaDataInterface::getMeshPropertyInternal(), MeshMetaDataInterface::hasMeshProperty(), MeshMetaDataInterface::meshPropertyName(), and MeshGenerator::setMeshPropertyHelper().

 {
   return std::string(SYSTEM) + "/" + prefix + "/" + data_name;
 }

◆ meshPropertyName() [2/2]

std::string MeshMetaDataInterface::meshPropertyName ( const std::string & data_name ) const

inlineprotectedinherited

Returns: The default mesh property name for mesh property data

Definition at line 95 of file MeshMetaDataInterface.h.

   {
     return meshPropertyName(data_name, meshPropertyPrefix(data_name));
   }

◆ messagePrefix()

std::string MooseBase::messagePrefix ( const bool hit_prefix = true ) const

inlineinherited

Returns: A prefix to be used in messages that contain the input file location associated with this object (if any) and the name and type of the object.

Definition at line 252 of file MooseBase.h.

Referenced by MooseBase::callMooseError(), MooseBase::errorPrefix(), MooseBase::mooseDeprecated(), MooseBase::mooseInfo(), and MooseBase::mooseWarning().

   {
     return messagePrefix(_pars, hit_prefix);
   }

◆ mooseDeprecated()

template<typename... Args>

void MooseBase::mooseDeprecated ( Args &&... args ) const

inlineinherited

Definition at line 310 of file MooseBase.h.

Referenced by FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), MooseApp::getRecoverFileBase(), FEProblemBase::getUserObjects(), FEProblemBase::hasPostprocessor(), MooseApp::hasRecoverFileBase(), MatDiffusionBase< Real >::MatDiffusionBase(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), PercentChangePostprocessor::PercentChangePostprocessor(), ReferenceResidualConvergence::ReferenceResidualConvergence(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), MooseApp::setupOptions(), UserForcingFunction::UserForcingFunction(), and VariableResidual::VariableResidual().

   {
     moose::internal::mooseDeprecatedStream(
         _console, false, true, messagePrefix(true), std::forward<Args>(args)...);
   }

◆ mooseDocumentedError()

template<typename... Args>

void MooseBase::mooseDocumentedError	(	const std::string &	repo_name,
		const unsigned int	issue_num,
		Args &&...	args
	)		const

inlineinherited

Definition at line 273 of file MooseBase.h.

Referenced by ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), DGLowerDKernel::DGLowerDKernel(), HFEMDirichletBC::HFEMDirichletBC(), and LowerDIntegratedBC::LowerDIntegratedBC().

   {
     callMooseError(moose::internal::formatMooseDocumentedError(
                        repo_name, issue_num, argumentsToString(std::forward<Args>(args)...)),
                    /* with_prefix = */ true);
   }

◆ mooseError()

template<typename... Args>

void MooseBase::mooseError ( Args &&... args ) const

inlineinherited

Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.

Definition at line 267 of file MooseBase.h.

   {
     callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ true);
   }

◆ mooseErrorNonPrefixed()

template<typename... Args>

void MooseBase::mooseErrorNonPrefixed ( Args &&... args ) const

inlineinherited

Emits an error without the prefixing included in mooseError().

Definition at line 286 of file MooseBase.h.

   {
     callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ false);
   }

◆ mooseInfo()

template<typename... Args>

void MooseBase::mooseInfo ( Args &&... args ) const

inlineinherited

Definition at line 317 of file MooseBase.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), PIDTransientControl::execute(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), DataFileInterface::getDataFilePath(), MFEMScalarFESpace::getFECName(), MultiAppTransfer::getPointInTargetAppFrame(), ImplicitMidpoint::ImplicitMidpoint(), ParsedDownSelectionPositions::initialize(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), MooseBase::paramInfo(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), MFEMDataCollection::registerFields(), FEProblemBase::setRestartFile(), MooseApp::setupOptions(), SolutionUserObjectBase::SolutionUserObjectBase(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), and TransientBase::TransientBase().

   {
     moose::internal::mooseInfoStream(_console, messagePrefix(true), std::forward<Args>(args)...);
   }

◆ mooseWarning()

template<typename... Args>

void MooseBase::mooseWarning ( Args &&... args ) const

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 295 of file MooseBase.h.

Referenced by CopyMeshPartitioner::_do_partition(), AddKernelAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), MFEMProblem::addFunction(), MooseMesh::addPeriodicVariable(), DiracKernelBase::addPoint(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), SampledOutput::cloneMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), VariableValueElementSubdomainModifier::computeSubdomainID(), GapValueAux::computeValue(), MultiApp::createApp(), DebugResidualAux::DebugResidualAux(), MeshDiagnosticsGenerator::diagnosticsLog(), CartesianGridDivision::divisionIndex(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), ElementMaterialSampler::ElementMaterialSampler(), Postprocessor::evaluateDotWarning(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), SubdomainPerElementGenerator::generate(), StitchMeshGenerator::generate(), ParsedGenerateSideset::generate(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), DataFileInterface::getDataFilePath(), PointSamplerBase::getLocalElemContainingPoint(), FEProblemBase::getMaterial(), LineValueSampler::getValue(), Terminator::handleMessage(), IndicatorMarker::IndicatorMarker(), CartesianGridDivision::initialize(), CylindricalGridDivision::initialize(), SphericalGridDivision::initialize(), ElementGroupCentroidPositions::initialize(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), BoundsBase::initialSetup(), ReferenceResidualConvergence::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), LeastSquaresFit::LeastSquaresFit(), IterationAdaptiveDT::limitDTToPostprocessorValue(), MooseApp::loadLibraryAndDependencies(), FEProblemBase::mesh(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), MooseBase::paramWarning(), PiecewiseConstantFromCSV::PiecewiseConstantFromCSV(), Executioner::problem(), PropertyReadFile::readData(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), SampledOutput::updateSample(), PiecewiseConstantFromCSV::value(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

   {
     moose::internal::mooseWarningStream(_console, messagePrefix(true), std::forward<Args>(args)...);
   }

◆ mooseWarningNonPrefixed()

template<typename... Args>

void MooseBase::mooseWarningNonPrefixed ( Args &&... args ) const

inlineinherited

Emits a warning without the prefixing included in mooseWarning().

Definition at line 304 of file MooseBase.h.

   {
     moose::internal::mooseWarningStream(_console, std::forward<Args>(args)...);
   }

◆ name()

const std::string& MooseBase::name ( ) const

inlineinherited

Get the name of the class.

Returns: The name of the class

Definition at line 99 of file MooseBase.h.

   {
     mooseAssert(_name.size(), "Empty name");
     return _name;
   }

◆ paramError()

template<typename... Args>

void MooseBase::paramError	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseError - only printing a message using the given args.

Definition at line 435 of file MooseBase.h.

 {
   _pars.paramError(param, std::forward<Args>(args)...);
 }

◆ parameters()

const InputParameters& MooseBase::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 127 of file MooseBase.h.

127 { return _pars; }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

◆ paramInfo()

template<typename... Args>

void MooseBase::paramInfo	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseInfo - only printing a message using the given args.

Definition at line 449 of file MooseBase.h.

Referenced by GridPartitioner::_do_partition(), ComboMarker::ComboMarker(), Control::Control(), FunctorIC::FunctorIC(), and TransientMultiApp::TransientMultiApp().

 {
   mooseInfo(_pars.paramMessage(param, std::forward<Args>(args)...));
 }

◆ paramWarning()

template<typename... Args>

void MooseBase::paramWarning	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseWarning - only printing a message using the given args.

Definition at line 442 of file MooseBase.h.

Referenced by GridPartitioner::_do_partition(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), EigenProblem::checkProblemIntegrity(), CombinerGenerator::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), UniqueExtraIDMeshGenerator::generate(), PlaneIDMeshGenerator::generate(), Terminator::initialSetup(), SampledOutput::initSample(), MooseMesh::MooseMesh(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

 {
   mooseWarning(_pars.paramMessage(param, std::forward<Args>(args)...));
 }

◆ 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 226 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(), 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();
   }
 }

◆ queryParam()

template<typename T >

const T * MooseBase::queryParam ( const std::string & name ) const

inherited

Query a parameter for the object.

If the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

Returns: A pointer to the parameter value, if it exists

Definition at line 391 of file MooseBase.h.

 {
   return isParamValid(name) ? &getParam<T>(name) : nullptr;
 }

◆ setHasGenerateData()

void MeshGenerator::setHasGenerateData ( InputParameters & params )

staticinherited

Sets that a mesh generator has a generateData() implementation.

This must be called in the validParams() implementation for all mesh generators that implement generateData().

Definition at line 80 of file MeshGenerator.C.

Referenced by AddMetaDataGenerator::validParams().

 {
   params.set<bool>("_has_generate_data") = true;
 }

◆ setMeshProperty() [1/2]

template<typename T , typename... Args>

T & MeshGenerator::setMeshProperty	(	const std::string &	data_name,
		Args &&...	args
	)

protectedinherited

Method for updating attributes to the mesh meta-data store, which can only be invoked in the MeshGenerator generate routine only if the mesh generator property has already been declared.

Definition at line 485 of file MeshGenerator.h.

 {
   if (_app.actionWarehouse().getCurrentTaskName() != "execute_mesh_generators")
     mooseError("Updating mesh meta data with setMeshProperty() can only be called during "
                "MeshGenerator::generate()");
 
   if (!hasMeshProperty(data_name))
     mooseError("Failed to get the mesh property '", data_name, "'");
   RestartableDataValue * value = &setMeshPropertyHelper(data_name);
   RestartableData<T> * T_value = dynamic_cast<RestartableData<T> *>(value);
   if (!T_value)
     mooseError("While retrieving mesh property '",
                data_name,
                "' with type '",
                MooseUtils::prettyCppType<T>(),
                "',\nthe property was found with type '",
                value->type(),
                "'");
 
   // Set the value if someone provided arguments to set it to
   if constexpr (sizeof...(args) > 0)
     T_value->set() = T(std::forward<Args>(args)...);
 
   return T_value->set();
 }

◆ setMeshProperty() [2/2]

template<typename T >

T& MeshGenerator::setMeshProperty	(	const std::string &	data_name,
		const T &	data_value
	)

inlineprotectedinherited

Definition at line 221 of file MeshGenerator.h.

   {
     return setMeshProperty<T, const T &>(data_name, data_value);
   }

◆ 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 Boundary2DDelaunayGenerator(), CutMeshByPlaneGenerator::CutMeshByPlaneGenerator(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedODEKernel::ParsedODEKernel(), and TransfiniteMeshGenerator::TransfiniteMeshGenerator().

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

◆ type()

const std::string& MooseBase::type ( ) const

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 89 of file MooseBase.h.

   {
     mooseAssert(_type.size(), "Empty type");
     return _type;
   }

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

Get the class's combined type and name; useful in error handling.

Returns: The type and name of this class in the form '<type()> "<name()>"'.

Definition at line 54 of file MooseBase.C.

Referenced by FEProblemBase::addPostprocessor(), MaterialPropertyStorage::addProperty(), FEProblemBase::addReporter(), FEProblemBase::addVectorPostprocessor(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< std::vector< T > >::finalize(), and ReporterData::getReporterInfo().

 {
   return type() + std::string(" \"") + name() + std::string("\"");
 }

◆ uniqueName()

MooseObjectName MooseBase::uniqueName ( ) const

inherited

Returns: The unique name for accessing input parameters of this object in the InputParameterWarehouse

Definition at line 66 of file MooseBase.C.

Referenced by MooseBase::connectControllableParams(), and Action::uniqueActionName().

 {
   if (!_pars.have_parameter<std::string>(unique_name_param))
     mooseError("uniqueName(): Object does not have a unique name");
   return MooseObjectName(_pars.get<std::string>(unique_name_param));
 }

◆ uniqueParameterName()

MooseObjectParameterName MooseBase::uniqueParameterName ( const std::string & parameter_name ) const

inherited

Returns: The unique parameter name of a valid parameter of this object for accessing parameter controls

Definition at line 60 of file MooseBase.C.

 {
   return MooseObjectParameterName(getBase(), name(), parameter_name);
 }

◆ validParams()

InputParameters Boundary2DDelaunayGenerator::validParams ( )

static

Definition at line 24 of file Boundary2DDelaunayGenerator.C.

 {
   InputParameters params = SurfaceDelaunayGeneratorBase::validParams();
   params += FunctionParserUtils<false>::validParams();
 
   params.addClassDescription(
       "Mesh generator that convert a 2D surface given as one or a few boundaries of a 3D mesh into "
       "a 2D mesh using Delaunay triangulation.");
   params.addRequiredParam<MeshGeneratorName>("input", "The mesh we want to modify");
   params.addRequiredParam<std::vector<BoundaryName>>("boundary_names", "The boundaries to be used");
   params.addParam<std::vector<std::vector<BoundaryName>>>(
       "hole_boundary_names",
       std::vector<std::vector<BoundaryName>>(),
       "The optional boundaries to be used as the holes in the mesh during triangulation. Note that "
       "this is a vector of vectors, which allows each hole to be defined as a combination of "
       "multiple boundaries.");
 
   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.addRangeCheckedParam<Real>(
       "max_angle_deviation",
       60.0,
       "max_angle_deviation>0 & max_angle_deviation<90",
       "Maximum angle deviation from the global average normal vector in the input mesh.");
 
   params.addParam<BoundaryName>(
       "output_external_boundary_name",
       "",
       "The optional name of the external boundary of the mesh to generate. If not provided, the "
       "external boundary will be have a trivial id of 0.");
 
   return params;
 }

Member Data Documentation

◆ _action_factory

ActionFactory& ParallelParamObject::_action_factory

protectedinherited

Builds Actions.

Definition at line 40 of file ParallelParamObject.h.

Referenced by AddActionComponentAction::act(), CreateMeshSetupActionsForComponents::act(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 353 of file MooseBase.h.

◆ _auto_area_func_default_size

const Real SurfaceDelaunayGeneratorBase::_auto_area_func_default_size

protectedinherited

Background size for automatic desired area function.

Definition at line 31 of file SurfaceDelaunayGeneratorBase.h.

Referenced by General2DDelaunay(), and XYDelaunayGenerator::generate().

◆ _auto_area_func_default_size_dist

const Real SurfaceDelaunayGeneratorBase::_auto_area_func_default_size_dist

protectedinherited

Background size's effective distance for automatic desired area function.

Definition at line 34 of file SurfaceDelaunayGeneratorBase.h.

Referenced by General2DDelaunay(), and XYDelaunayGenerator::generate().

◆ _auto_area_function_num_points

const unsigned int SurfaceDelaunayGeneratorBase::_auto_area_function_num_points

protectedinherited

Maximum number of points to use for the inverse distance interpolation for automatic area function.

Definition at line 37 of file SurfaceDelaunayGeneratorBase.h.

Referenced by General2DDelaunay(), and XYDelaunayGenerator::generate().

◆ _auto_area_function_power

const Real SurfaceDelaunayGeneratorBase::_auto_area_function_power

protectedinherited

Power of the polynomial used in the inverse distance interpolation for automatic area function.

Definition at line 40 of file SurfaceDelaunayGeneratorBase.h.

Referenced by General2DDelaunay(), and XYDelaunayGenerator::generate().

◆ _boundary_names

const std::vector<BoundaryName> Boundary2DDelaunayGenerator::_boundary_names

protected

The boundaries to be converted to a 2D mesh.

Definition at line 32 of file Boundary2DDelaunayGenerator.h.

Referenced by generate().

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

An instance of helper class to write streams to the Console objects.

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _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().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects.

Definition at line 50 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _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

◆ _factory

Factory& ParallelParamObject::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 37 of file ParallelParamObject.h.

Referenced by ElementIDOutputAction::act(), AutoCheckpointAction::act(), CreateExecutionerAction::act(), PartitionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), CombineComponentsMeshes::act(), SetupMeshAction::act(), AdaptivityAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), SetupDebugAction::act(), ComposeTimeStepperAction::act(), SetupPreconditionerAction::act(), SetupResidualDebugAction::act(), MaterialDerivativeTestAction::act(), CreateDisplacedProblemAction::act(), SetAdaptivityOptionsAction::act(), DisplayGhostingAction::act(), AddControlAction::act(), MaterialOutputAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), AddNodalNormalsAction::act(), ComponentMeshTransformHelper::addMeshGenerators(), CylinderComponent::addMeshGenerators(), DiffusionPhysicsBase::addPostprocessors(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), SampledOutput::cloneMesh(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), ActionComponent::getFactory(), PhysicsBase::getFactory(), MaterialOutputAction::getParams(), and ProjectedStatefulMaterialStorageAction::processProperty().

◆ _func_level_set

SymFunctionPtr Boundary2DDelaunayGenerator::_func_level_set

protected

function parser object describing the level set

Definition at line 47 of file Boundary2DDelaunayGenerator.h.

Referenced by Boundary2DDelaunayGenerator(), General2DDelaunay(), and levelSetEvaluator().

◆ _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(), Boundary2DDelaunayGenerator(), ParsedVectorAux::computeValue(), ArrayParsedAux::computeValue(), ParsedAux::computeValue(), CutMeshByLevelSetGenerator::CutMeshByLevelSetGenerator(), CutMeshByPlaneGenerator::CutMeshByPlaneGenerator(), ParsedPostprocessor::finalize(), ParsedSubdomainGeneratorBase::functionInitialize(), ParsedGenerateNodeset::generate(), ParsedCurveGenerator::generate(), ParsedExtraElementIDGenerator::generate(), ParsedNodeTransformGenerator::generate(), ParsedGenerateSideset::generate(), ParsedDownSelectionPositions::initialize(), CutMeshByLevelSetGeneratorBase::levelSetEvaluator(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedElementDeletionGenerator::ParsedElementDeletionGenerator(), ParsedExtraElementIDGenerator::ParsedExtraElementIDGenerator(), ParsedGenerateNodeset::ParsedGenerateNodeset(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedNodeTransformGenerator::ParsedNodeTransformGenerator(), ParsedODEKernel::ParsedODEKernel(), ParsedPostprocessor::ParsedPostprocessor(), ParsedCurveGenerator::pointCalculator(), ParsedElementDeletionGenerator::shouldDelete(), SolutionUserObject::solutionSampleTime(), SolutionUserObject::SolutionUserObject(), TransfiniteMeshGenerator::TransfiniteMeshGenerator(), and ParsedODEKernel::updateParams().

◆ _hole_boundary_names

const std::vector<std::vector<BoundaryName> > Boundary2DDelaunayGenerator::_hole_boundary_names

protected

The boundaries to be used as holes.

Definition at line 35 of file Boundary2DDelaunayGenerator.h.

Referenced by generate().

◆ _input

std::unique_ptr<MeshBase>& Boundary2DDelaunayGenerator::_input

protected

The input mesh name.

Definition at line 29 of file Boundary2DDelaunayGenerator.h.

Referenced by generate().

◆ _max_angle_deviation

const Real Boundary2DDelaunayGenerator::_max_angle_deviation

protected

Max angle deviation from the global average normal vector in the input mesh.

Definition at line 41 of file Boundary2DDelaunayGenerator.h.

Referenced by General2DDelaunay().

◆ _max_level_set_correction_iterations

const unsigned int Boundary2DDelaunayGenerator::_max_level_set_correction_iterations

protected

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

Definition at line 38 of file Boundary2DDelaunayGenerator.h.

Referenced by General2DDelaunay().

◆ _mesh

MooseMesh* const MeshGenerator::_mesh

protectedinherited

Pointer to the owning mesh.

Definition at line 388 of file MeshGenerator.h.

Referenced by MeshGenerator::buildDistributedMesh(), MeshGenerator::buildMeshBaseObject(), MeshGenerator::buildReplicatedMesh(), and DistributedRectilinearMeshGenerator::generate().

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 359 of file MooseBase.h.

◆ _output_external_boundary_name

BoundaryName Boundary2DDelaunayGenerator::_output_external_boundary_name

protected

The name of the external boundary of the mesh to generate.

Definition at line 44 of file Boundary2DDelaunayGenerator.h.

Referenced by General2DDelaunay().

◆ _pars

const InputParameters& MooseBase::_pars

protectedinherited

The object's parameters.

Definition at line 362 of file MooseBase.h.

Referenced by AddFVICAction::act(), AddICAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupMeshAction::act(), ComposeTimeStepperAction::act(), SetupDebugAction::act(), AddAuxKernelAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PiecewiseTabularBase::buildFromFile(), PNGOutput::calculateRescalingValues(), MooseBase::callMooseError(), MooseBase::connectControllableParams(), Console::Console(), MooseApp::copyInputs(), MaterialBase::declareADProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateData(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), GlobalParamsAction::parameters(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), Eigenvalue::prepareSolverOptions(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _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.

◆ _type

const std::string& MooseBase::_type

protectedinherited

The type of this class.

Definition at line 356 of file MooseBase.h.

Referenced by ExplicitTimeIntegrator::ExplicitTimeIntegrator(), FEProblemSolve::FEProblemSolve(), FillBetweenSidesetsGenerator::generate(), FillBetweenCurvesGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), ExplicitTimeIntegrator::init(), FEProblemBase::init(), MooseBase::MooseBase(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), FEProblemBase::solverTypeString(), and MooseBase::type().

◆ _use_auto_area_func

const bool SurfaceDelaunayGeneratorBase::_use_auto_area_func

protectedinherited

Whether to use automatic desired area function.

Definition at line 28 of file SurfaceDelaunayGeneratorBase.h.

Referenced by General2DDelaunay(), XYDelaunayGenerator::generate(), and XYDelaunayGenerator::XYDelaunayGenerator().

◆ app_param

const std::string MooseBase::app_param = "_moose_app"

staticinherited

The name of the parameter that contains the MooseApp.

Definition at line 59 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MeshGenerator::addMeshSubgenerator(), InputParameters::callMooseError(), ActionFactory::create(), Factory::getValidParams(), ActionFactory::getValidParams(), AutomaticMortarGeneration::initOutput(), SetupMeshAction::modifyParamsForUseSplit(), and MortarNodalGeometryOutput::validParams().

◆ data_only_param

const std::string MeshGenerator::data_only_param = "_data_only"

staticinherited

The name of the private parameter for setting data only.

Definition at line 62 of file MeshGenerator.h.

Referenced by MeshGenerator::addMeshSubgenerator(), MeshGeneratorSystem::createAddedMeshGenerators(), and MeshGenerator::validParams().

◆ moose_base_param

const std::string MooseBase::moose_base_param = "_moose_base"

staticinherited

The name of the parameter that contains the moose system base.

Definition at line 61 of file MooseBase.h.

Referenced by InputParameters::getBase(), InputParameters::hasBase(), and InputParameters::registerBase().

◆ NAME

constexpr auto MeshMetaDataInterface::NAME = "<empty>"

staticinherited

The data name used when initializing the Restartable interface for non-MeshGenerator objects.

Definition at line 33 of file MeshMetaDataInterface.h.

◆ name_param

const std::string MooseBase::name_param = "_object_name"

staticinherited

The name of the parameter that contains the object name.

Definition at line 55 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), MooseObjectUnitTest::buildObjects(), ActionFactory::create(), AppFactory::create(), InputParameters::getObjectName(), AutomaticMortarGeneration::initOutput(), InputParameters::isMooseBaseObject(), MooseMesh::prepare(), CouplingFunctorCheckAction::validParams(), and MooseBase::validParams().

◆ SYSTEM

constexpr auto MeshMetaDataInterface::SYSTEM = "MeshMetaData"

staticinherited

The system name used when initializing the Restartable interface.

Definition at line 30 of file MeshMetaDataInterface.h.

Referenced by MeshMetaDataInterface::meshPropertyName().

◆ type_param

const std::string MooseBase::type_param = "_type"

staticinherited

The name of the parameter that contains the object type.

Definition at line 53 of file MooseBase.h.

Referenced by ActionFactory::create(), AppFactory::create(), InputParameters::getObjectType(), Factory::initialize(), InputParameters::isMooseBaseObject(), MooseBase::validParams(), and MortarNodalGeometryOutput::validParams().

◆ unique_name_param

const std::string MooseBase::unique_name_param = "_unique_name"

staticinherited

The name of the parameter that contains the unique object name.

Definition at line 57 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), AppFactory::create(), InputParameterWarehouse::removeInputParameters(), MooseBase::uniqueName(), and MooseBase::validParams().

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

include/meshgenerators/Boundary2DDelaunayGenerator.h
src/meshgenerators/Boundary2DDelaunayGenerator.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

◆ SymFunction

◆ SymFunctionPtr

Member Enumeration Documentation

◆ FailureMethod

Constructor & Destructor Documentation

◆ Boundary2DDelaunayGenerator()

Member Function Documentation

◆ addChildMeshGenerator()

◆ addFParserConstants()

◆ addMeshSubgenerator() [1/2]

◆ addMeshSubgenerator() [2/2]

◆ addParentMeshGenerator()

◆ buildDistributedMesh()

◆ buildMeshBaseObject()

◆ buildReplicatedMesh()

◆ callMooseError() [1/2]

◆ callMooseError() [2/2]

◆ connectControllableParams()

◆ copyMeshProperty() [1/2]

◆ copyMeshProperty() [2/2]

◆ declareMeshesForSub()

◆ declareMeshesForSubByName()

◆ declareMeshForSub()

◆ declareMeshForSubByName()

◆ declareMeshProperty() [1/2]

◆ declareMeshProperty() [2/2]

◆ declareNullMeshName()

◆ elemNormal()

◆ enabled()

◆ errorPrefix()

◆ evaluate() [1/2]

◆ evaluate() [2/2]

◆ functionsOptimize() [1/3]

◆ functionsOptimize() [2/3]

◆ functionsOptimize() [3/3]

◆ General2DDelaunay()

◆ generate()

◆ generateData()

◆ generateInternal()

◆ getBase()

◆ getCheckedPointerParam()

◆ getChildMeshGenerators()

◆ getDataFileName()

◆ getDataFileNameByName()

◆ getDataFilePath()

◆ getHitNode()

◆ getMesh()

◆ getMeshByName()

◆ getMeshes()

◆ getMeshesByName()

◆ getMeshProperty() [1/2]

◆ getMeshProperty() [2/2]

◆ getMooseApp()

◆ getParam() [1/2]

◆ getParam() [2/2]

◆ getParentMeshGenerators()

◆ getRenamedParam()

◆ getRequestedMeshGenerators()

◆ getRequestedMeshGeneratorsForSub()

◆ getSavedMeshName()

◆ getSharedPtr() [1/2]

◆ getSharedPtr() [2/2]

◆ getSubMeshGenerators()

◆ hasBase()

◆ hasGenerateData() [1/2]

◆ hasGenerateData() [2/2]

◆ hasMeshProperty() [1/4]