Creates lower-dimensional elements on the specified sidesets. More...

#include <LowerDBlockFromSidesetGenerator.h>

Inheritance diagram for LowerDBlockFromSidesetGenerator:

Public Member Functions
	LowerDBlockFromSidesetGenerator (const InputParameters &parameters)

std::unique_ptr< MeshBase >	generate () override
	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...

virtual 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 &	getParamTempl (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) 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...

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

Static Public Member Functions
static InputParameters	validParams ()

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

Static Public Attributes
static constexpr auto	FILE_SUFFIX = "_mesh"
	The suffix appended when writing the restartable data file. 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 Member Functions
template<typename T >
T &	declareMeshProperty (const std::string &data_name)
	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 &init_value)

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

Protected Attributes
std::unique_ptr< MeshBase > &	_input

const std::vector< BoundaryName >	_sideset_names

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

Private Member Functions
template<typename... Args>
std::string	paramErrorMsg (const std::string &param, Args... args) const

RestartableDataValue &	registerMetaDataOnApp (const std::string &name, std::unique_ptr< RestartableDataValue > data)
	Helper function for actually registering the restartable data. More...

Private Attributes
std::vector< std::string >	_depends_on
	A list of generators that are required to run before this generator may run. More...

std::unique_ptr< MeshBase >	_null_mesh = nullptr
	A nullptr to use for when inputs aren't specified. More...

MooseApp &	_meta_data_app
	Reference to the application. More...

Detailed Description

Creates lower-dimensional elements on the specified sidesets.

Definition at line 23 of file LowerDBlockFromSidesetGenerator.h.

Constructor & Destructor Documentation

◆ LowerDBlockFromSidesetGenerator()

LowerDBlockFromSidesetGenerator::LowerDBlockFromSidesetGenerator ( const InputParameters & parameters )

Definition at line 43 of file LowerDBlockFromSidesetGenerator.C.

   : MeshGenerator(parameters),
     _input(getMesh("input")),
     _sideset_names(getParam<std::vector<BoundaryName>>("sidesets"))
 {
 }

Member Function Documentation

◆ declareMeshProperty() [1/2]

template<typename T >

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

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 99 of file MeshGenerator.h.

 {
   std::string full_name =
       std::string(MeshMetaDataInterface::SYSTEM) + "/" + name() + "/" + data_name;
  
   // Here we will create the RestartableData even though we may not use this instance.
   // If it's already in use, the App will return a reference to the existing instance and we'll
   // return that one instead. We might refactor this to have the app create the RestartableData
   // at a later date.
   auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, nullptr);
   auto & restartable_data_ref = static_cast<RestartableData<T> &>(
       _app.registerRestartableData(full_name, std::move(data_ptr), 0, true, false));
  
   return restartable_data_ref.get();
 }

◆ declareMeshProperty() [2/2]

template<typename T >

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

protectedinherited

Definition at line 117 of file MeshGenerator.h.

 {
   T & data = declareMeshProperty<T>(data_name);
   data = init_value;
  
   return data;
 }

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 110 of file MooseObject.h.

110 { return _enabled; }

Referenced by EigenKernel::enabled().

◆ generate()

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

overridevirtual

Generate / modify the mesh.

Implements MeshGenerator.

Definition at line 61 of file LowerDBlockFromSidesetGenerator.C.

 {
   std::unique_ptr<MeshBase> mesh = std::move(_input);
  
   // Generate a new block id if one isn't supplied.
   SubdomainID new_block_id;
   if (isParamValid("new_block_id"))
     new_block_id = getParam<SubdomainID>("new_block_id");
   else
   {
     std::set<SubdomainID> preexisting_subdomain_ids;
     mesh->subdomain_ids(preexisting_subdomain_ids);
     if (preexisting_subdomain_ids.empty())
       new_block_id = 0;
     else
     {
       const auto highest_subdomain_id =
           *std::max_element(preexisting_subdomain_ids.begin(), preexisting_subdomain_ids.end());
       mooseAssert(highest_subdomain_id < std::numeric_limits<SubdomainID>::max(),
                   "A SubdomainID with max possible value was found");
       new_block_id = highest_subdomain_id + 1;
     }
   }
  
   bool distributed = false;
   if (typeid(mesh).name() == typeid(std::unique_ptr<DistributedMesh>).name())
     distributed = true;
  
   auto side_list = mesh->get_boundary_info().build_side_list();
   std::sort(side_list.begin(),
             side_list.end(),
             [](std::tuple<dof_id_type, unsigned short int, boundary_id_type> a,
                std::tuple<dof_id_type, unsigned short int, boundary_id_type> b) {
               auto a_elem_id = std::get<0>(a);
               auto b_elem_id = std::get<0>(b);
               if (a_elem_id == b_elem_id)
               {
                 auto a_side_id = std::get<1>(a);
                 auto b_side_id = std::get<1>(b);
                 if (a_side_id == b_side_id)
                   return std::get<2>(a) < std::get<2>(b);
                 else
                   return a_side_id < b_side_id;
               }
               else
                 return a_elem_id < b_elem_id;
             });
  
   auto sideset_ids = MooseMeshUtils::getBoundaryIDs(*mesh, _sideset_names, true);
   std::set<boundary_id_type> sidesets(sideset_ids.begin(), sideset_ids.end());
  
   std::vector<ElemSideDouble> element_sides_on_boundary;
   for (const auto & triple : side_list)
     if (sidesets.count(std::get<2>(triple)))
       element_sides_on_boundary.push_back(
           ElemSideDouble(mesh->elem_ptr(std::get<0>(triple)), std::get<1>(triple)));
  
   dof_id_type max_elem_id = mesh->max_elem_id();
   mesh->comm().max(max_elem_id);
   auto max_elems_to_add = element_sides_on_boundary.size();
   mesh->comm().max(max_elems_to_add);
  
   for (MooseIndex(element_sides_on_boundary) i = 0; i < element_sides_on_boundary.size(); ++i)
   {
     Elem * elem = element_sides_on_boundary[i].elem;
     if (distributed && elem->processor_id() != processor_id())
       continue;
  
     unsigned int side = element_sides_on_boundary[i].side;
  
     // Build a non-proxy element from this side.
     std::unique_ptr<Elem> side_elem(elem->build_side_ptr(side, /*proxy=*/false));
  
     // The side will be added with the same processor id as the parent.
     side_elem->processor_id() = elem->processor_id();
  
     // Add subdomain ID
     side_elem->subdomain_id() = new_block_id;
  
     // Also assign the side's interior parent, so it is always
     // easy to figure out the Elem we came from.
     side_elem->set_interior_parent(elem);
  
     // Add id for distributed
     if (distributed)
       side_elem->set_id(max_elem_id + processor_id() * max_elems_to_add + i);
  
     // Finally, add the lower-dimensional element to the Mesh.
     mesh->add_elem(side_elem.release());
   };
  
   // Assign block name, if provided
   if (isParamValid("new_block_name"))
     mesh->subdomain_name(new_block_id) = getParam<SubdomainName>("new_block_name");
  
   return mesh;
 }

◆ 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 91 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 53 of file MeshGenerator.h.

53 { return _depends_on; }

◆ 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 31 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 46 of file MeshGenerator.C.

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

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

◆ getMeshProperty()

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 72 of file MeshMetaDataInterface.h.

 {
   std::string full_name = std::string(SYSTEM) + "/" + prefix + "/" + data_name;
   auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, nullptr);
  
   // Here we will create the RestartableData even though we may not use this instance.
   // If it's already in use, the App will return a reference to the existing instance and we'll
   // return that one instead. We might refactor this to have the app create the RestartableData
   // at a later date.
   auto & restartable_data_ref =
       static_cast<RestartableData<T> &>(registerMetaDataOnApp(full_name, std::move(data_ptr)));
  
   return restartable_data_ref.get();
 }

◆ getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const

inlineinherited

Get the MooseApp this object is associated with.

Definition at line 105 of file MooseObject.h.

105 { return _app; }

Referenced by MortarData::createMortarInterface(), Executioner::Executioner(), and ConsoleUtils::outputMeshInformation().

◆ getParamTempl()

template<typename T >

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

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

Referenced by FEProblemBase::addMaterialHelper(), ConstraintWarehouse::addObject(), EigenKernel::EigenKernel(), AttribThread::initFrom(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), Console::initialSetup(), ConsoleUtils::outputExecutionInformation(), and TimePeriod::TimePeriod().

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

100 { return _pars.isParamValid(name); }

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 156 of file MooseObject.h.

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

Referenced by FEProblemBase::addArrayVariable(), FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::addScalarVariable(), FEProblemBase::addVariable(), ADFunctionPresetBC< compute_stage >::ADFunctionPresetBC(), ADPresetBC< compute_stage >::ADPresetBC(), ADPresetNodalBC< compute_stage >::ADPresetNodalBC(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), FEProblemBase::computeResidual(), MaterialBase::declarePropertyOlderTempl(), MaterialBase::declarePropertyOldTempl(), MooseMesh::elem(), MultiAppTransfer::execFlags(), UserForcingFunction::f(), FaceFaceConstraint< compute_stage >::FaceFaceConstraint(), FunctionDT::FunctionDT(), FunctionPresetBC::FunctionPresetBC(), RandomICBase::generateRandom(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), Sampler::getSamples(), FEProblemBase::getUserObjects(), FEProblemBase::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValueOld(), MatDiffusionBase< Real >::MatDiffusionBase(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), PercentChangePostprocessor::PercentChangePostprocessor(), PresetBC::PresetBC(), PresetNodalBC::PresetNodalBC(), Sampler::rand(), ReferenceResidualProblem::ReferenceResidualProblem(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

◆ mooseError()

template<typename... Args>

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

inlineinherited

Definition at line 141 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 162 of file MooseObject.h.

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

Referenced by AStableDirk4::AStableDirk4(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), ParsedMaterialHelper::functionsOptimize(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), MooseObject::paramInfo(), DerivativeParsedMaterialHelper::recurseDerivative(), ReferenceResidualProblem::ReferenceResidualProblem(), and FEProblemBase::setRestartFile().

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Definition at line 150 of file MooseObject.h.

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

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

◆ name()

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

inlinevirtualinherited

Get the name of the object.

Returns: The name of the object TODO:MooseVariableToMooseObject (see #10601)

Reimplemented in MooseVariableBase.

Definition at line 70 of file MooseObject.h.

70 { return _name; }

◆ paramError()

template<typename... Args>

void MooseObject::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 215 of file MooseObject.h.

 {
   Moose::show_trace = false;
   mooseError(paramErrorMsg(param, std::forward<Args>(args)...));
   Moose::show_trace = true;
 }

◆ paramErrorMsg()

template<typename... Args>

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

inlineprivateinherited

Definition at line 185 of file MooseObject.h.

   {
     auto prefix = paramErrorPrefix(_pars, param);
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     std::string msg = oss.str();
  
     // Wrap error message to a separate line from prefix if it is about to
     // blow past 100 chars.  But only wrap if the prefix is long enough (12
     // chars) for the wrap to buy us much extra length.
     if ((prefix.size() > 12 && msg.size() + prefix.size() > 99) ||
         msg.find("\n") != std::string::npos)
     {
       if (prefix.size() > 0 && prefix[prefix.size() - 1] != ':')
         prefix += ":";
       return prefix + "\n    " + MooseUtils::replaceAll(msg, "\n", "\n    ");
     }
     return prefix + " " + msg;
   }

Referenced by MooseObject::paramError(), MooseObject::paramInfo(), and MooseObject::paramWarning().

◆ parameters()

const InputParameters& MooseObject::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 76 of file MooseObject.h.

76 { return _pars; }

◆ paramInfo()

template<typename... Args>

void MooseObject::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 231 of file MooseObject.h.

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

Referenced by TransientMultiApp::TransientMultiApp().

◆ paramWarning()

template<typename... Args>

void MooseObject::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 224 of file MooseObject.h.

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

Referenced by Executioner::Executioner().

◆ registerMetaDataOnApp()

RestartableDataValue & MeshMetaDataInterface::registerMetaDataOnApp	(	const std::string &	name,
		std::unique_ptr< RestartableDataValue >	data
	)

privateinherited

Helper function for actually registering the restartable data.

Definition at line 23 of file MeshMetaDataInterface.C.

 {
   return _meta_data_app.registerRestartableData(name, std::move(data), 0, true, true);
 }

Referenced by MeshMetaDataInterface::getMeshProperty().

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

63 { return _type; }

◆ validParams()

InputParameters LowerDBlockFromSidesetGenerator::validParams ( )

static

Definition at line 27 of file LowerDBlockFromSidesetGenerator.C.

 {
   InputParameters params = MeshGenerator::validParams();
  
   params.addRequiredParam<MeshGeneratorName>("input", "The mesh we want to modify");
   params.addParam<SubdomainID>("new_block_id", "The lower dimensional block id to create");
   params.addParam<SubdomainName>("new_block_name",
                                  "The lower dimensional block name to create (optional)");
   params.addRequiredParam<std::vector<BoundaryName>>(
       "sidesets", "The sidesets from which to create the new block");
  
   params.addClassDescription("Adds lower dimensional elements on the specified sidesets.");
  
   return params;
 }

Member Data Documentation

◆ _app

MooseApp& MooseObject::_app

protectedinherited

The MooseApp this object is associated with.

Definition at line 172 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), AB2PredictorCorrector::AB2PredictorCorrector(), Executioner::addAttributeReporter(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addOutput(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), MooseMesh::buildMeshBaseObject(), FEProblemBase::checkNonlinearConvergence(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), MultiApp::createApp(), MeshGenerator::declareMeshProperty(), 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(), NumRelationshipManagers::getValue(), GhostingUserObject::GhostingUserObject(), NonlinearEigen::init(), InversePowerMethod::init(), Transient::init(), Steady::init(), MooseMesh::init(), NumPicardIterations::initialize(), TimePeriod::initialSetup(), Console::initialSetup(), MultiApp::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutput(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), ElementSideNeighborLayers::internalInit(), MeshGeneratorMesh::MeshGeneratorMesh(), MooseObject::mooseError(), EigenExecutionerBase::normalizeSolution(), AugmentSparsityOnInterface::operator()(), 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(), Eigenvalue::postSolve(), Transient::preExecute(), 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 31 of file ConsoleStreamInterface.h.

◆ _depends_on

std::vector<std::string> MeshGenerator::_depends_on

privateinherited

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

Definition at line 91 of file MeshGenerator.h.

Referenced by MeshGenerator::getDependencies(), MeshGenerator::getMesh(), and MeshGenerator::getMeshByName().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 181 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _input

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

protected

Definition at line 33 of file LowerDBlockFromSidesetGenerator.h.

Referenced by generate().

◆ _mesh

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

protectedinherited

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

Definition at line 87 of file MeshGenerator.h.

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

◆ _meta_data_app

MooseApp& MeshMetaDataInterface::_meta_data_app

privateinherited

Reference to the application.

Definition at line 67 of file MeshMetaDataInterface.h.

Referenced by MeshMetaDataInterface::registerMetaDataOnApp().

◆ _name

const std::string& MooseObject::_name

protectedinherited

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

Definition at line 178 of file MooseObject.h.

Referenced by ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), PiecewiseBase::buildFromFile(), PiecewiseBase::buildFromXY(), PiecewiseLinearBase::buildInterpolation(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), MooseObject::name(), PiecewiseBilinear::parse(), PiecewiseBase::PiecewiseBase(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), DerivativeParsedMaterialHelper::recurseDerivative(), PiecewiseBase::setData(), Split::setup(), and VectorPostprocessorFunction::VectorPostprocessorFunction().

◆ _null_mesh

std::unique_ptr<MeshBase> MeshGenerator::_null_mesh = nullptr

privateinherited

A nullptr to use for when inputs aren't specified.

Definition at line 94 of file MeshGenerator.h.

Referenced by MeshGenerator::getMesh().

◆ _pars

const InputParameters& MooseObject::_pars

protectedinherited

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

Definition at line 169 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PNGOutput::calculateRescalingValues(), BreakMeshByBlockBase::checkInputParameter(), RandomPartitioner::clone(), PetscExternalPartitioner::clone(), BlockWeightedPartitioner::clone(), GridPartitioner::clone(), Console::Console(), Eigenvalue::execute(), Executioner::Executioner(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), ExtraNodesetGenerator::generate(), MooseObject::getParamTempl(), GeneralUserObject::getPostprocessorValue(), InitialConditionBase::getUserObjectBase(), InitialConditionBase::getUserObjectTempl(), GeneralUserObject::getVectorPostprocessorValue(), Transient::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseObject::isParamValid(), AddExtraNodeset::modify(), MooseObject::paramErrorMsg(), MooseObject::parameters(), MooseMesh::setPartitionerHelper(), and Transient::setupTimeIntegrator().

◆ _sideset_names

const std::vector<BoundaryName> LowerDBlockFromSidesetGenerator::_sideset_names

protected

Definition at line 35 of file LowerDBlockFromSidesetGenerator.h.

Referenced by generate().

◆ _type

const std::string& MooseObject::_type

protectedinherited

The type of this object (the Class name)

Definition at line 175 of file MooseObject.h.

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

◆ FILE_SUFFIX

constexpr auto MeshMetaDataInterface::FILE_SUFFIX = "_mesh"

staticconstexprinherited

The suffix appended when writing the restartable data file.

Definition at line 32 of file MeshMetaDataInterface.h.

Referenced by SetupRecoverFileBaseAction::act(), and Checkpoint::output().

◆ NAME

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

staticconstexprinherited

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

Definition at line 38 of file MeshMetaDataInterface.h.

◆ SYSTEM

constexpr auto MeshMetaDataInterface::SYSTEM = "MeshMetaData"

staticconstexprinherited

The system name used when initializing the Restartable interface.

Definition at line 35 of file MeshMetaDataInterface.h.

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

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

include/meshgenerators/LowerDBlockFromSidesetGenerator.h
src/meshgenerators/LowerDBlockFromSidesetGenerator.C

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LowerDBlockFromSidesetGenerator()

Member Function Documentation

◆ declareMeshProperty() [1/2]

◆ declareMeshProperty() [2/2]

◆ enabled()

◆ generate()

◆ getCheckedPointerParam()

◆ getDependencies()

◆ getMesh()

◆ getMeshByName()

◆ getMeshProperty()

◆ getMooseApp()

◆ getParamTempl()

◆ isParamValid()

◆ mooseDeprecated()

◆ mooseError()

◆ mooseInfo()

◆ mooseWarning()

◆ name()

◆ paramError()

◆ paramErrorMsg()

◆ parameters()

◆ paramInfo()

◆ paramWarning()

◆ registerMetaDataOnApp()

◆ type()

◆ validParams()

Member Data Documentation

◆ _app

◆ _console

◆ _depends_on

◆ _enabled

◆ _input

◆ _mesh

◆ _meta_data_app

◆ _name

◆ _null_mesh

◆ _pars

◆ _sideset_names

◆ _type

◆ FILE_SUFFIX

◆ NAME

◆ SYSTEM