#include <SideSetsGeneratorBase.h>

Inheritance diagram for SideSetsGeneratorBase:

Public Member Functions
	SideSetsGeneratorBase (const InputParameters &parameters)

virtual	~SideSetsGeneratorBase ()

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

std::vector< std::string > &	getDependencies ()
	Return the MeshGenerators that must run before this MeshGenerator. More...

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

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

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

template<typename T >
const T &	getParam (const std::string &name) const
	Retrieve a 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...

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

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

template<typename... Args>
void	paramError (const std::string &param, Args... args)
	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)
	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)
	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...

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

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

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

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

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

Protected Member Functions
void	setup (MeshBase &mesh)
	This method is used to construct the FE object so we can compute normals of faces. More...

void	finalize ()
	This method finalizes the object, setting names back in the boundary_info object and releasing memory. More...

void	flood (const Elem *elem, Point normal, boundary_id_type side_id, MeshBase &mesh)
	This method implements a recursive flood routine to paint a sideset of mesh to neighboring faces given a starting element and normal. More...

boundary_id_type	getNextBoundaryID () const

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

std::unique_ptr< MeshBase > &	getMeshByName (const MeshGeneratorName &input_mesh_generator_parameter_name)
	Takes the name of another MeshGenerator directly. More...

template<typename T >
T &	declareRestartableData (std::string data_name)
	Declare a piece of data as "restartable". More...

template<typename T >
T &	declareRestartableData (std::string data_name, const T &init_value)
	Declare a piece of data as "restartable" and initialize it. More...

template<typename T >
T &	declareRestartableDataWithContext (std::string data_name, void *context)
	Declare a piece of data as "restartable". More...

template<typename T >
T &	declareRestartableDataWithContext (std::string data_name, const T &init_value, void *context)
	Declare a piece of data as "restartable" and initialize it. More...

template<typename T >
T &	declareRecoverableData (std::string data_name)
	Declare a piece of data as "recoverable". More...

template<typename T >
T &	declareRecoverableData (std::string data_name, const T &init_value)
	Declare a piece of data as "restartable" and initialize it. More...

template<typename T >
T &	declareRestartableDataWithObjectName (std::string data_name, std::string object_name)
	Declare a piece of data as "restartable". More...

template<typename T >
T &	declareRestartableDataWithObjectNameWithContext (std::string data_name, std::string object_name, void *context)
	Declare a piece of data as "restartable". More...

Protected Attributes
Real	_variance

bool	_fixed_normal

std::unique_ptr< FEBase >	_fe_face

std::unique_ptr< QGauss >	_qface

std::map< boundary_id_type, std::set< const Elem * > >	_visited

std::shared_ptr< MooseMesh > &	_mesh
	References to the mesh and displaced mesh (currently in the ActionWarehouse) More...

const InputParameters &	_pars
	Parameters of this object, references the InputParameters stored in the InputParametersWarehouse. More...

MooseApp &	_app
	The MooseApp this object is associated with. More...

const std::string &	_type
	The type of this object (the Class name) More...

const std::string &	_name
	The name of this object, reference to value stored in InputParameters. More...

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

Detailed Description

Definition at line 31 of file SideSetsGeneratorBase.h.

Constructor & Destructor Documentation

◆ SideSetsGeneratorBase()

SideSetsGeneratorBase::SideSetsGeneratorBase ( const InputParameters & parameters )

Definition at line 38 of file SideSetsGeneratorBase.C.

   : MeshGenerator(parameters),
     _variance(getParam<Real>("variance")),
     _fixed_normal(getParam<bool>("fixed_normal"))
 {
 }

◆ ~SideSetsGeneratorBase()

SideSetsGeneratorBase::~SideSetsGeneratorBase ( )

virtual

Definition at line 45 of file SideSetsGeneratorBase.C.

45 {}

Member Function Documentation

◆ declareRecoverableData() [1/2]

template<typename T >

T & Restartable::declareRecoverableData ( std::string data_name )

protectedinherited

Declare a piece of data as "recoverable".

This means that in the event of a recovery this piece of data will be restored back to its previous value.

Note - this data will NOT be restored on Restart!

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name The name of the data (usually just use the same name as the member variable)

Definition at line 269 of file Restartable.h.

 {
   std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
 
   registerRecoverableDataOnApp(full_name);
 
   return declareRestartableDataWithContext<T>(data_name, nullptr);
 }

◆ declareRecoverableData() [2/2]

template<typename T >

T & Restartable::declareRecoverableData	(	std::string	data_name,
		const T &	init_value
	)

protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

Note - this data will NOT be restored on Restart!

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
init_value	The initial value of the data

Definition at line 280 of file Restartable.h.

 {
   std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
 
   registerRecoverableDataOnApp(full_name);
 
   return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
 }

◆ declareRestartableData() [1/2]

template<typename T >

T & Restartable::declareRestartableData ( std::string data_name )

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name The name of the data (usually just use the same name as the member variable)

Definition at line 202 of file Restartable.h.

 {
   return declareRestartableDataWithContext<T>(data_name, nullptr);
 }

◆ declareRestartableData() [2/2]

template<typename T >

T & Restartable::declareRestartableData	(	std::string	data_name,
		const T &	init_value
	)

protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
init_value	The initial value of the data

Definition at line 209 of file Restartable.h.

 {
   return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
 }

◆ declareRestartableDataWithContext() [1/2]

template<typename T >

T & Restartable::declareRestartableDataWithContext	(	std::string	data_name,
		void *	context
	)

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
context	Context pointer that will be passed to the load and store functions

Definition at line 216 of file Restartable.h.

 {
   std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
   auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
   T & restartable_data_ref = data_ptr->get();
 
   registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid);
 
   return restartable_data_ref;
 }

◆ declareRestartableDataWithContext() [2/2]

template<typename T >

T & Restartable::declareRestartableDataWithContext	(	std::string	data_name,
		const T &	init_value,
		void *	context
	)

protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
init_value	The initial value of the data
context	Context pointer that will be passed to the load and store functions

Definition at line 229 of file Restartable.h.

 {
   std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
   auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
   data_ptr->set() = init_value;
 
   T & restartable_data_ref = data_ptr->get();
   registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid);
 
   return restartable_data_ref;
 }

◆ declareRestartableDataWithObjectName()

template<typename T >

T & Restartable::declareRestartableDataWithObjectName	(	std::string	data_name,
		std::string	object_name
	)

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
object_name	A supplied name for the object that is declaring this data.

Definition at line 245 of file Restartable.h.

 {
   return declareRestartableDataWithObjectNameWithContext<T>(data_name, object_name, nullptr);
 }

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T >

T & Restartable::declareRestartableDataWithObjectNameWithContext	(	std::string	data_name,
		std::string	object_name,
		void *	context
	)

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
object_name	A supplied name for the object that is declaring this data.
context	Context pointer that will be passed to the load and store functions

Definition at line 252 of file Restartable.h.

 {
   std::string old_name = _restartable_name;
 
   _restartable_name = object_name;
 
   T & value = declareRestartableDataWithContext<T>(data_name, context);
 
   _restartable_name = old_name;
 
   return value;
 }

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 96 of file MooseObject.h.

Referenced by EigenKernel::enabled().

96 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

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

Definition: MooseObject.h:183

◆ finalize()

void SideSetsGeneratorBase::finalize ( )

protected

This method finalizes the object, setting names back in the boundary_info object and releasing memory.

Definition at line 63 of file SideSetsGeneratorBase.C.

Referenced by SideSetsFromNormalsGenerator::generate(), SideSetsFromPointsGenerator::generate(), AllSideSetsByNormalsGenerator::generate(), and ParsedGenerateSideset::generate().

 {
   _qface.reset();
   _fe_face.reset();
 }

◆ flood()

void SideSetsGeneratorBase::flood	(	const Elem *	elem,
		Point	normal,
		boundary_id_type	side_id,
		MeshBase &	mesh
	)

protected

This method implements a recursive flood routine to paint a sideset of mesh to neighboring faces given a starting element and normal.

Definition at line 70 of file SideSetsGeneratorBase.C.

Referenced by SideSetsFromNormalsGenerator::generate(), SideSetsFromPointsGenerator::generate(), and AllSideSetsByNormalsGenerator::generate().

 {
   if (elem == nullptr || (_visited[side_id].find(elem) != _visited[side_id].end()))
     return;
 
   _visited[side_id].insert(elem);
   for (unsigned int side = 0; side < elem->n_sides(); ++side)
   {
     if (elem->neighbor_ptr(side))
       continue;
 
     _fe_face->reinit(elem, side);
     const std::vector<Point> normals = _fe_face->get_normals();
 
     // We'll just use the normal of the first qp
     if (std::abs(1.0 - normal * normals[0]) <= _variance)
     {
       mesh.get_boundary_info().add_side(elem, side, side_id);
       for (unsigned int neighbor = 0; neighbor < elem->n_sides(); ++neighbor)
       {
         // Flood to the neighboring elements using the current matching side normal from this
         // element.
         // This will allow us to tolerate small changes in the normals so we can "paint" around a
         // curve.
         flood(elem->neighbor_ptr(neighbor), _fixed_normal ? normal : normals[0], side_id, mesh);
       }
     }
   }
 }

◆ generate()

virtual std::unique_ptr<MeshBase> MeshGenerator::generate ( )

pure virtualinherited

Generate / modify the mesh.

Implemented in BoundingBoxNodeSetGenerator, PatternedMeshGenerator, SubdomainBoundingBoxGenerator, SideSetsAroundSubdomainGenerator, ElementDeletionGeneratorBase, ParsedGenerateSideset, RinglebMeshGenerator, SpiralAnnularMeshGenerator, OrientedSubdomainBoundingBoxGenerator, AllSideSetsByNormalsGenerator, ImageMeshGenerator, MeshExtruderGenerator, SideSetsFromBoundingBoxGenerator, StackGenerator, StitchedMeshGenerator, ConcentricCircleMeshGenerator, GeneratedMeshGenerator, ImageSubdomainGenerator, ParsedSubdomainMeshGenerator, AnnularMeshGenerator, BreakBoundaryOnSubdomainGenerator, ElementGenerator, ElementSubdomainIDGenerator, ExtraNodesetGenerator, FileMeshGenerator, LowerDBlockFromSidesetGenerator, MeshSideSetGenerator, RenameBlockGenerator, RenameBoundaryGenerator, SideSetsBetweenSubdomainsGenerator, SideSetsFromNormalsGenerator, SideSetsFromPointsGenerator, SmoothMeshGenerator, SubdomainIDGenerator, TiledMeshGenerator, TransformGenerator, CartesianMeshGenerator, and BreakMeshByBlockGenerator.

◆ getCheckedPointerParam()

template<typename T >

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

inlineinherited

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 77 of file MooseObject.h.

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

◆ getDependencies()

std::vector<std::string>& MeshGenerator::getDependencies ( )

inlineinherited

Return the MeshGenerators that must run before this MeshGenerator.

Definition at line 49 of file MeshGenerator.h.

49 { return _depends_on; }

MeshGenerator::_depends_on

std::vector< std::string > _depends_on

A list of generators that are required to run before this generator may run.

Definition: MeshGenerator.h:77

◆ getMesh()

std::unique_ptr< MeshBase > & MeshGenerator::getMesh ( const std::string & input_mesh_generator_parameter_name )

protectedinherited

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

NOTE: You MUST catch this by reference!

Returns: The Mesh generated by that MeshGenerator

Definition at line 32 of file MeshGenerator.C.

 {
   if (isParamValid(input_mesh_generator_parameter_name))
   {
     auto name = getParam<MeshGeneratorName>(input_mesh_generator_parameter_name);
 
     _depends_on.push_back(name);
 
     return _app.getMeshGeneratorOutput(name);
   }
   else
     return _null_mesh;
 }

◆ getMeshByName()

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

protectedinherited

Takes the name of another MeshGenerator directly.

NOTE: You MUST catch this by reference!

Returns: The Mesh generated by that MeshGenerator

Definition at line 47 of file MeshGenerator.C.

Referenced by PatternedMeshGenerator::PatternedMeshGenerator(), StackGenerator::StackGenerator(), and StitchedMeshGenerator::StitchedMeshGenerator().

 {
   _depends_on.push_back(input_mesh_generator);
   return _app.getMeshGeneratorOutput(input_mesh_generator);
 }

◆ getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const

inlineinherited

Get the MooseApp this object is associated with.

Definition at line 91 of file MooseObject.h.

Referenced by RestartableDataIO::createBackup(), RestartableDataIO::deserializeRestartableData(), ConsoleUtils::outputMeshInformation(), Resurrector::restartRestartableData(), and RestartableDataIO::restoreBackup().

91 { return _app; }

MooseObject::_app

MooseApp & _app

The MooseApp this object is associated with.

Definition: MooseObject.h:174

◆ getNextBoundaryID()

boundary_id_type SideSetsGeneratorBase::getNextBoundaryID ( ) const

protected

◆ getParam()

template<typename T >

const T & MooseObject::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 188 of file MooseObject.h.

Referenced by FEProblemBase::addMaterialHelper(), ConstraintWarehouse::addObject(), BicubicSplineFunction::BicubicSplineFunction(), Piecewise::buildFromXandY(), MultiApp::createApp(), DerivativeParsedMaterial::DerivativeParsedMaterial(), EigenKernel::EigenKernel(), FEProblemBase::FEProblemBase(), FieldSplitPreconditioner::FieldSplitPreconditioner(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), SideSetsBetweenSubdomainsGenerator::generate(), ExtraNodesetGenerator::generate(), MeshExtruderGenerator::generate(), SideSetsAroundSubdomainGenerator::generate(), GenericConstantRankTwoTensor::GenericConstantRankTwoTensor(), TimeSequenceStepper::init(), AttribThread::initFrom(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), Console::initialSetup(), AdvancedOutput::initialSetup(), SideSetsBetweenSubdomains::modify(), AddExtraNodeset::modify(), MeshExtruder::modify(), SideSetsAroundSubdomain::modify(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedMaterial::ParsedMaterial(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), SingleMatrixPreconditioner::SingleMatrixPreconditioner(), TimePeriod::TimePeriod(), and VectorOfPostprocessors::VectorOfPostprocessors().

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

◆ isParamValid()

bool MooseObject::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 86 of file MooseObject.h.

86 { return _pars.isParamValid(name); }

MooseObject::_pars

const InputParameters & _pars

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition: MooseObject.h:171

MooseObject::name

const std::string & name() const

Get the name of the object.

Definition: MooseObject.h:56

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:257

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 158 of file MooseObject.h.

Referenced by FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), FEProblemBase::computeResidual(), Material::declarePropertyOld(), Material::declarePropertyOlder(), MooseMesh::elem(), MultiAppTransfer::execFlags(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), FEProblemBase::getUserObjects(), FEProblemBase::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValueOld(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), PercentChangePostprocessor::PercentChangePostprocessor(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

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

◆ mooseError()

template<typename... Args>

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

inlineinherited

Definition at line 144 of file MooseObject.h.

                                                       {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     std::string msg = oss.str();
     callMooseErrorRaw(msg, &_app);
   }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 164 of file MooseObject.h.

Referenced by DerivativeParsedMaterialHelper::assembleDerivatives(), AStableDirk4::AStableDirk4(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), ParsedMaterialHelper::functionsOptimize(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), and MooseObject::paramInfo().

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

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Definition at line 152 of file MooseObject.h.

Referenced by CartesianMeshGenerator::CartesianMeshGenerator(), OversampleOutput::cloneMesh(), GapValueAux::computeValue(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), ElementSubdomainIDGenerator::generate(), MooseMesh::getBoundaryIDs(), FEProblemBase::getMaterial(), MooseMesh::getSubdomainIDs(), DerivativeFunctionMaterialBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), LeastSquaresFit::LeastSquaresFit(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), AssignElementSubdomainID::modify(), MultiAppTransfer::MultiAppTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MooseObject::paramWarning(), Executioner::problem(), Material::resetQpProperties(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), and Checkpoint::updateCheckpointFiles().

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

◆ name()

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

inlineinherited

Get the name of the object.

Returns: The name of the object

Definition at line 56 of file MooseObject.h.

56 { return _name; }

MooseObject::_name

const std::string & _name

The name of this object, reference to value stored in InputParameters.

Definition: MooseObject.h:180

◆ paramError()

template<typename... Args>

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

inlineinherited

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 105 of file MooseObject.h.

Referenced by ADIntegratedBCTempl< T, compute_stage >::ADIntegratedBCTempl(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), DGKernel::DGKernel(), ElementValueSampler::ElementValueSampler(), StackGenerator::generate(), StitchedMeshGenerator::generate(), MultiApp::init(), IntegratedBC::IntegratedBC(), Kernel::Kernel(), NodalBC::NodalBC(), NodalEqualValueConstraint::NodalEqualValueConstraint(), NodalKernel::NodalKernel(), NodalValueSampler::NodalValueSampler(), RandomIC::RandomIC(), MultiAppCopyTransfer::transfer(), and TransientMultiApp::TransientMultiApp().

                                                                       {
     auto prefix = param + ": ";
     if (!_pars.inputLocation(param).empty())
       prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
     mooseError(prefix, args...);
   }

◆ parameters()

const InputParameters& MooseObject::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 62 of file MooseObject.h.

62 { return _pars; }

MooseObject::_pars

const InputParameters & _pars

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition: MooseObject.h:171

◆ paramInfo()

template<typename... Args>

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

inlineinherited

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 135 of file MooseObject.h.

Referenced by TransientMultiApp::TransientMultiApp().

   {
     auto prefix = param + ": ";
     if (!_pars.inputLocation(param).empty())
       prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
     mooseInfo(prefix, args...);
   }

◆ paramWarning()

template<typename... Args>

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

inlineinherited

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 119 of file MooseObject.h.

   {
     auto prefix = param + ": ";
     if (!_pars.inputLocation(param).empty())
       prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
     mooseWarning(prefix, args...);
   }

◆ setup()

void SideSetsGeneratorBase::setup ( MeshBase & mesh )

protected

This method is used to construct the FE object so we can compute normals of faces.

Additionaly this method also grabs the sideset ids from the mesh given a list of sideset names.

Definition at line 48 of file SideSetsGeneratorBase.C.

Referenced by SideSetsFromNormalsGenerator::generate(), SideSetsFromPointsGenerator::generate(), AllSideSetsByNormalsGenerator::generate(), ParsedGenerateSideset::generate(), and SideSetsAroundSubdomainGenerator::generate().

 {
   mooseAssert(_fe_face == nullptr, "FE Face has already been initialized");
 
   unsigned int dim = mesh.mesh_dimension();
 
   // Setup the FE Object so we can calculate normals
   FEType fe_type(Utility::string_to_enum<Order>("CONSTANT"),
                  Utility::string_to_enum<FEFamily>("MONOMIAL"));
   _fe_face = FEBase::build(dim, fe_type);
   _qface = libmesh_make_unique<QGauss>(dim - 1, FIRST);
   _fe_face->attach_quadrature_rule(_qface.get());
 }

◆ type()

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

inlineinherited

Get the type of this object.

Returns: the name of the type of this object

Definition at line 50 of file MooseObject.h.

50 { return _type; }

MooseObject::_type

const std::string & _type

The type of this object (the Class name)

Definition: MooseObject.h:177

Member Data Documentation

◆ _app

MooseApp& MooseObject::_app

protectedinherited

The MooseApp this object is associated with.

Definition at line 174 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), AB2PredictorCorrector::AB2PredictorCorrector(), Executioner::addAttributeReporter(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addOutput(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), AlgebraicRelationshipManager::attachAlgebraicFunctorHelper(), RelationshipManager::attachRelationshipManagers(), ElementSideNeighborLayers::attachRelationshipManagersInternal(), ElementPointNeighbors::attachRelationshipManagersInternal(), FileMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), MooseMesh::buildMeshBaseObject(), FEProblemBase::checkNonlinearConvergence(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), MultiApp::createApp(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::dumpVariableHelper(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), NonlinearEigen::execute(), InversePowerMethod::execute(), Transient::execute(), Steady::execute(), FileOutput::FileOutput(), FEProblemBase::forceOutput(), MeshGenerator::getMesh(), MeshGenerator::getMeshByName(), MooseObject::getMooseApp(), InversePowerMethod::init(), NonlinearEigen::init(), Transient::init(), Steady::init(), MooseMesh::init(), NumPicardIterations::initialize(), TimePeriod::initialSetup(), Console::initialSetup(), MultiApp::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutput(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), InversePowerMethod::InversePowerMethod(), MooseObject::mooseError(), NonlinearEigen::NonlinearEigen(), EigenExecutionerBase::normalizeSolution(), PerfGraphOutput::output(), Tecplot::output(), Exodus::output(), Nemesis::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), MultiApp::parentOutputPositionChanged(), PerformanceData::PerformanceData(), PetscOutput::petscLinearOutput(), PetscOutput::petscNonlinearOutput(), FEProblemBase::projectSolution(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), FEProblemBase::timestepSetup(), Transient::Transient(), and Console::write().

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

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

Definition at line 32 of file ConsoleStreamInterface.h.

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 183 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _fe_face

std::unique_ptr<FEBase> SideSetsGeneratorBase::_fe_face

protected

Definition at line 62 of file SideSetsGeneratorBase.h.

Referenced by finalize(), flood(), SideSetsFromNormalsGenerator::generate(), SideSetsFromPointsGenerator::generate(), AllSideSetsByNormalsGenerator::generate(), ParsedGenerateSideset::generate(), SideSetsAroundSubdomainGenerator::generate(), and setup().

◆ _fixed_normal

bool SideSetsGeneratorBase::_fixed_normal

protected

Definition at line 60 of file SideSetsGeneratorBase.h.

Referenced by flood().

◆ _mesh

std::shared_ptr<MooseMesh>& MeshGenerator::_mesh

protectedinherited

References to the mesh and displaced mesh (currently in the ActionWarehouse)

Definition at line 73 of file MeshGenerator.h.

Referenced by AnnularMeshGenerator::generate(), FileMeshGenerator::generate(), ElementGenerator::generate(), GeneratedMeshGenerator::generate(), and AllSideSetsByNormalsGenerator::generate().

◆ _name

const std::string& MooseObject::_name

protectedinherited

The name of this object, reference to value stored in InputParameters.

Definition at line 180 of file MooseObject.h.

Referenced by DerivativeParsedMaterialHelper::assembleDerivatives(), Piecewise::buildFromFile(), Piecewise::buildFromXandY(), Piecewise::buildFromXY(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), PiecewiseBase::initialSetup(), MooseObject::name(), PiecewiseBilinear::parse(), Piecewise::Piecewise(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseBase::setData(), Split::setup(), and VectorPostprocessorFunction::VectorPostprocessorFunction().

◆ _pars

const InputParameters& MooseObject::_pars

protectedinherited

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition at line 171 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), BreakMeshByBlockBase::checkInputParameter(), PetscExternalPartitioner::clone(), GridPartitioner::clone(), Console::Console(), Eigenvalue::Eigenvalue(), Eigenvalue::execute(), Executioner::Executioner(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), ExtraNodesetGenerator::generate(), MooseObject::getParam(), GeneralUserObject::getPostprocessorValue(), AuxKernel::getPostprocessorValue(), AuxKernel::getScatterVectorPostprocessorValue(), AuxKernel::getUserObject(), InitialConditionBase::getUserObject(), InitialConditionBase::getUserObjectBase(), AuxKernel::getUserObjectBase(), GeneralUserObject::getVectorPostprocessorValue(), AuxKernel::getVectorPostprocessorValue(), Transient::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseObject::isParamValid(), AddExtraNodeset::modify(), MooseObject::paramError(), MooseObject::parameters(), MooseObject::paramInfo(), MooseObject::paramWarning(), and Transient::setupTimeIntegrator().

◆ _qface

std::unique_ptr<QGauss> SideSetsGeneratorBase::_qface

protected

Definition at line 63 of file SideSetsGeneratorBase.h.

Referenced by finalize(), and setup().

◆ _type

const std::string& MooseObject::_type

protectedinherited

The type of this object (the Class name)

Definition at line 177 of file MooseObject.h.

Referenced by FEProblemBase::init(), and MooseObject::type().

◆ _variance

Real SideSetsGeneratorBase::_variance

protected

Definition at line 59 of file SideSetsGeneratorBase.h.

Referenced by flood(), and ParsedGenerateSideset::generate().

◆ _visited

std::map<boundary_id_type, std::set<const Elem *> > SideSetsGeneratorBase::_visited

protected

Definition at line 64 of file SideSetsGeneratorBase.h.

Referenced by flood(), SideSetsFromNormalsGenerator::generate(), SideSetsFromPointsGenerator::generate(), and AllSideSetsByNormalsGenerator::generate().

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

include/meshgenerators/SideSetsGeneratorBase.h
src/meshgenerators/SideSetsGeneratorBase.C

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SideSetsGeneratorBase()

◆ ~SideSetsGeneratorBase()

Member Function Documentation

◆ declareRecoverableData() [1/2]

◆ declareRecoverableData() [2/2]

◆ declareRestartableData() [1/2]

◆ declareRestartableData() [2/2]

◆ declareRestartableDataWithContext() [1/2]

◆ declareRestartableDataWithContext() [2/2]

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ enabled()

◆ finalize()

◆ flood()

◆ generate()

◆ getCheckedPointerParam()

◆ getDependencies()

◆ getMesh()

◆ getMeshByName()

◆ getMooseApp()

◆ getNextBoundaryID()

◆ getParam()

◆ isParamValid()

◆ mooseDeprecated()

◆ mooseError()

◆ mooseInfo()

◆ mooseWarning()

◆ name()

◆ paramError()

◆ parameters()

◆ paramInfo()

◆ paramWarning()

◆ setup()

◆ type()

Member Data Documentation

◆ _app

◆ _console

◆ _enabled

◆ _fe_face

◆ _fixed_normal

◆ _mesh

◆ _name

◆ _pars

◆ _qface

◆ _type

◆ _variance

◆ _visited