#include <SBMSurfaceMeshBuilder.h>

Inheritance diagram for SBMSurfaceMeshBuilder:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	SBMSurfaceMeshBuilder (const InputParameters &parameters)

virtual void	initialSetup () override

virtual void	initialize () override

virtual void	execute () override

virtual void	finalize () override

KDTree &	getKDTree () const
	Returns a mutable reference because KDTree::neighborSearch is non-const (nanoflann's knnSearch threads internal scratch state through the call). More...

bool	hasKDTree () const
	Whether this builder has a KDTree available. More...

const std::vector< std::unique_ptr< SBMBndElementBase > > &	getBoundaryElements () const
	Get the SBM boundary elements. More...

const std::vector< Point > &	getCentroids () const
	Get the centroids of the boundary elements. More...

bool	checkWatertightness () const
	Checks whether the boundary mesh is "closed" – i.e. More...

virtual Real	spatialValue (const Point &) const

virtual const std::vector< Point >	spatialPoints () const

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

SubProblem &	getSubProblem () const

bool	shouldDuplicateInitialExecution () const

void	gatherSum (T &value)

void	gatherMax (T &value)

void	gatherMin (T &value)

void	gatherProxyValueMax (T1 &proxy, T2 &value)

void	gatherProxyValueMin (T1 &proxy, T2 &value)

std::set< UserObjectName >	getDependObjects () const

const std::set< std::string > &	getRequestedItems () override

const std::set< std::string > &	getSuppliedItems () override

unsigned int	systemNumber () const

virtual bool	needThreadedCopy () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

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

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	mooseDeprecatedNoTrace (Args &&... args) const

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

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

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

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

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

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

UserObjectName	getUserObjectName (const std::string &param_name) const

const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const

const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const

const UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObjectBase &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const

const std::vector< MooseVariableScalar *> &	getCoupledMooseScalarVars ()

const std::set< TagID > &	getScalarVariableCoupleableVectorTags () const

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () const

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyByName (const std::string &prop_name_in)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOldByName (const std::string &prop_name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlderByName (const std::string &prop_name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialProperty (const std::string &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOld (const std::string &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlder (const std::string &name)

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)

std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > >	getKokkosBlockMaterialProperty (const MaterialPropertyName &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)

const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)

std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)

std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)

std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)

std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)

void	checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)

std::unordered_map< SubdomainID, std::vector< MaterialBase *> >	buildRequiredMaterials (bool allow_stateful=true)

void	statefulPropertiesAllowed (bool)

virtual bool	getMaterialPropertyCalled () const

virtual const std::unordered_set< unsigned int > &	getMatPropDependencies () const

virtual void	resolveOptionalProperties ()

const GenericMaterialProperty< T, is_ad > &	getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)

bool	isImplicit ()

Moose::StateArg	determineState () const

virtual void	threadJoin (const UserObject &) override

virtual void	threadJoin (const UserObject &) override

virtual void	subdomainSetup () override

virtual void	subdomainSetup () override

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasKokkosMaterialProperty (const std::string &name)

bool	hasKokkosMaterialProperty (const std::string &name)

bool	hasKokkosMaterialPropertyByName (const std::string &name)

bool	hasKokkosMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

const Function &	getFunction (const std::string &name) const

const Function &	getFunctionByName (const FunctionName &name) const

bool	hasFunction (const std::string &param_name) const

bool	hasFunctionByName (const FunctionName &name) const

Moose::Kokkos::Function	getKokkosFunction (const std::string &name) const

const T &	getKokkosFunction (const std::string &name) const

Moose::Kokkos::Function	getKokkosFunctionByName (const FunctionName &name) const

const T &	getKokkosFunctionByName (const FunctionName &name) const

bool	hasKokkosFunction (const std::string &param_name) const

bool	hasKokkosFunctionByName (const FunctionName &name) const

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessorByName (const PostprocessorName &name) const

std::size_t	coupledPostprocessors (const std::string &param_name) const

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const

T &	getSampler (const std::string &name)

Sampler &	getSampler (const std::string &name)

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

virtual void	meshChanged ()

virtual void	meshDisplaced ()

PerfGraph &	perfGraph ()

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

const Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

static void	sort (typename std::vector< T > &vector)

static void	sortDFS (typename std::vector< T > &vector)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header, NameFunc &&name_func)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
virtual void	addPostprocessorDependencyHelper (const PostprocessorName &name) const override

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override

virtual void	addUserObjectDependencyHelper (const UserObjectBase &uo) const override

void	addReporterDependencyHelper (const ReporterName &reporter_name) override

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const

const ReporterName &	getReporterName (const std::string &param_name) const

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

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

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

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

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

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

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

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

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

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

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

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

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

bool	isCoupledScalar (const std::string &var_name, unsigned int i=0) const

unsigned int	coupledScalarComponents (const std::string &var_name) const

unsigned int	coupledScalar (const std::string &var_name, unsigned int comp=0) const

libMesh::Order	coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< is_ad > &	coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const VariableValue &	coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const

const MooseVariableScalar *	getScalarVar (const std::string &var_name, unsigned int comp) const

virtual void	checkMaterialProperty (const std::string &name, const unsigned int state)

virtual void	getKokkosMaterialPropertyHook (const std::string &, const unsigned int)

void	markMatPropRequested (const std::string &)

MaterialPropertyName	getMaterialPropertyName (const std::string &name) const

void	checkExecutionStage ()

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

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

Protected Attributes
std::unique_ptr< MeshBase >	_mesh
	Holds the mesh to ensure boundary element pointers remain valid. More...

std::unique_ptr< KDTree >	_kd_tree
	The KDTree is constructed using the centroids of the elements in the boundary mesh. More...

std::vector< std::unique_ptr< SBMBndElementBase > >	_boundary_elements
	The boundary elements are stored in a vector of unique pointers to SBMBndElementBase. More...

std::vector< Point >	_centroids
	The centroids of the elements in the boundary mesh are stored in a vector of Points. The sequence is the same as in _boundary_elements. More...

const int	_leaf_max_size
	Configures KDTree leaf node size for performance tuning. More...

const std::string	_bnd_mesh_name
	The name of a mesh saved via MeshGenerator `save_mesh_as` parameter. More...

const bool	_check_watertightness
	The flag to check the watertightness of the mesh. More...

const bool	_build_kd_tree
	whether we want to build a kd-tree or not More...

const Moose::CoordinateSystemType &	_coord_sys

const THREAD_ID	_tid

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

Assembly &	_assembly

const bool	_duplicate_initial_execution

std::set< std::string >	_depend_uo

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

FEProblemBase &	_mdi_feproblem

MooseApp &	_pg_moose_app

const std::string	_prefix

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

const InputParameters &	_mi_params

const std::string	_mi_name

const MooseObjectName	_mi_moose_object_name

FEProblemBase &	_mi_feproblem

SubProblem &	_mi_subproblem

const THREAD_ID	_mi_tid

const bool	_is_kokkos_object

const Moose::MaterialDataType	_material_data_type

MaterialData &	_material_data

bool	_stateful_allowed

bool	_get_material_property_called

std::vector< std::unique_ptr< PropertyValue > >	_default_properties

std::unordered_set< unsigned int >	_material_property_dependencies

const MaterialPropertyName	_get_suffix

const bool	_use_interpolated_state

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

bool	_is_implicit

Real &	_t

const Real &	_t_old

int &	_t_step

Real &	_dt

Real &	_dt_old

bool	_is_transient

const Parallel::Communicator &	_communicator

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Private Attributes
const unsigned int	_dim_embedding_mesh
	The dimension of the embedding mesh (2D or 3D). More...

Detailed Description

Definition at line 17 of file SBMSurfaceMeshBuilder.h.

Constructor & Destructor Documentation

◆ SBMSurfaceMeshBuilder()

SBMSurfaceMeshBuilder::SBMSurfaceMeshBuilder ( const InputParameters & parameters )

Definition at line 56 of file SBMSurfaceMeshBuilder.C.

   : GeneralUserObject(parameters),
     _leaf_max_size(getParam<int>("leaf_max_size")),
     _bnd_mesh_name(getParam<std::string>("surface_mesh")),
     _check_watertightness(getParam<bool>("check_watertightness")),
     _build_kd_tree(getParam<bool>("build_kd_tree")),
     _dim_embedding_mesh(_fe_problem.mesh().dimension() /*MooseMesh*/)
 {
 }

Member Function Documentation

◆ checkWatertightness()

bool SBMSurfaceMeshBuilder::checkWatertightness ( ) const

Checks whether the boundary mesh is "closed" – i.e.

has no open edges or faces.

The implementation walks every side of every boundary element and returns false as soon as it finds a side with no neighbor. On a manifold surface mesh this is equivalent to watertightness; non-manifold input (e.g. T-junctions, three faces sharing an edge) is not validated here because the SBM workflow expects boundary meshes extracted from manifold sidesets.

Returns: true if every side has a neighbor; false otherwise.

Definition at line 126 of file SBMSurfaceMeshBuilder.C.

Referenced by initialSetup().

 {
   return SBMUtils::checkWatertightnessFromRawElems(std::vector<const Elem *>(
       _mesh->active_element_ptr_range().begin(), _mesh->active_element_ptr_range().end()));
 }

◆ execute()

virtual void SBMSurfaceMeshBuilder::execute ( )

inlineoverridevirtual

Implements GeneralUserObject.

Definition at line 25 of file SBMSurfaceMeshBuilder.h.

25 {}

◆ finalize()

virtual void SBMSurfaceMeshBuilder::finalize ( )

inlineoverridevirtual

Implements GeneralUserObject.

Definition at line 26 of file SBMSurfaceMeshBuilder.h.

26 {}

◆ getBoundaryElements()

const std::vector< std::unique_ptr< SBMBndElementBase > > & SBMSurfaceMeshBuilder::getBoundaryElements ( ) const

Get the SBM boundary elements.

Definition at line 140 of file SBMSurfaceMeshBuilder.C.

 {
   return _boundary_elements;
 }

◆ getCentroids()

const std::vector< Point > & SBMSurfaceMeshBuilder::getCentroids ( ) const

Get the centroids of the boundary elements.

Definition at line 146 of file SBMSurfaceMeshBuilder.C.

Referenced by ShortestDistanceToSurfaceTestAux::initialSetup().

 {
   return _centroids;
 }

◆ getKDTree()

KDTree & SBMSurfaceMeshBuilder::getKDTree ( ) const

Returns a mutable reference because KDTree::neighborSearch is non-const (nanoflann's knnSearch threads internal scratch state through the call).

The operation is logically read-only and knnSearch is re-entrant, so the same tree can be safely shared across threads without a const_cast at the call site. Callers must check hasKDTree() first; this is asserted in debug builds.

Definition at line 133 of file SBMSurfaceMeshBuilder.C.

 {
   mooseAssert(_kd_tree, "KDTree not built; callers must guard with hasKDTree() first.");
   return *_kd_tree;
 }

◆ hasKDTree()

bool SBMSurfaceMeshBuilder::hasKDTree ( ) const

inline

Whether this builder has a KDTree available.

Consumers that require the tree should check this in initialSetup and mooseError with a friendly message naming both objects.

Definition at line 37 of file SBMSurfaceMeshBuilder.h.

37 { return _kd_tree != nullptr; }

SBMSurfaceMeshBuilder::_kd_tree

std::unique_ptr< KDTree > _kd_tree

The KDTree is constructed using the centroids of the elements in the boundary mesh.

Definition: SBMSurfaceMeshBuilder.h:67

◆ initialize()

virtual void SBMSurfaceMeshBuilder::initialize ( )

inlineoverridevirtual

Implements GeneralUserObject.

Definition at line 24 of file SBMSurfaceMeshBuilder.h.

24 {}

◆ initialSetup()

void SBMSurfaceMeshBuilder::initialSetup ( )

overridevirtual

Reimplemented from GeneralUserObject.

Definition at line 67 of file SBMSurfaceMeshBuilder.C.

 {
   auto & mesh_generator_system = _app.getMeshGeneratorSystem();
 
   _mesh = mesh_generator_system.getSavedMesh(_bnd_mesh_name);
 
   const auto expected_dim_embedding_mesh = _mesh->mesh_dimension() + 1;
 
   if (!_mesh->is_replicated())
     mooseError(
         "The mesh is distributed. Please use a serial mesh for SBMSurfaceMeshBuilder, which is "
         "important for our In-Out test later.");
 
   if (_dim_embedding_mesh != expected_dim_embedding_mesh)
     mooseError("The original mesh dimension (",
                _dim_embedding_mesh,
                ") does not match the expected mesh dimension (",
                expected_dim_embedding_mesh,
                ").");
 
   const std::size_t num_elems = _mesh->n_elem();
 
   _centroids.resize(num_elems);
   _boundary_elements.resize(num_elems);
 
   int i = 0;
   for (auto elem_it = _mesh->active_elements_begin(); elem_it != _mesh->active_elements_end();
        ++elem_it)
   {
     const Elem * elem = *elem_it;
 
     const auto centroid = elem->vertex_average();
     if (_build_kd_tree)
       _centroids[i] = centroid;
 
     if (elem->type() == EDGE2)
       _boundary_elements[i] = std::make_unique<SBMBndEdge2>(elem);
     else if (elem->type() == TRI3)
       _boundary_elements[i] = std::make_unique<SBMBndTri3>(elem);
     else
       mooseError("Unsupported element type in SBMSurfaceMeshBuilder::initialSetup()");
 
     ++i;
   }
 
   if (_build_kd_tree)
     _kd_tree = std::make_unique<KDTree>(_centroids, _leaf_max_size);
 
   if (_check_watertightness)
   {
     bool watertight = checkWatertightness();
     if (!watertight)
       mooseInfo("The mesh is not watertight. It may not be suitable for In-Out tests.");
     else
       mooseInfo("The mesh is watertight. It is suitable for In-Out tests.");
   }
 }

◆ validParams()

InputParameters SBMSurfaceMeshBuilder::validParams ( )

static

Add a parameter for leaf_max_size for nanoflann

Checking watertightness is not mandatory, but it is a good practice to ensure the mesh is valid for In-Out test.

Add a parameter to control whether to build a kd-tree or not

Definition at line 20 of file SBMSurfaceMeshBuilder.C.

 {
   InputParameters params = GeneralUserObject::validParams();
   params.addClassDescription(
       "Constructs a KDTree and boundary elements from a pre-existing surface mesh. "
       "The surface mesh is specified in the Mesh block.");
 
   params.addRequiredParam<std::string>(
       "surface_mesh",
       "The name of the surface mesh saved via the MeshGenerator's `save_mesh_as` parameter.");
 
   params.addParam<int>(
       "leaf_max_size",
       10,
       "Maximum number of points allowed in a leaf node of the KDTree. "
       "Smaller values yield deeper trees with faster queries but slower build times; "
       "larger values result in shallower trees with faster builds but slower queries. "
       "Benchmarking is recommended to find an optimal tradeoff for your use case.");
 
   params.addParam<bool>(
       "check_watertightness",
       false,
       "Check if the mesh is watertight. If false, the mesh may not be suitable for In-Out tests.");
 
   params.addParam<bool>(
       "build_kd_tree",
       true,
       "Whether to build a kd-tree or not. If false, the kd-tree will not be built, "
       "and the mesh will be used directly for queries.");
 
   return params;
 }

Member Data Documentation

◆ _bnd_mesh_name

const std::string SBMSurfaceMeshBuilder::_bnd_mesh_name

protected

The name of a mesh saved via MeshGenerator save_mesh_as parameter.

Definition at line 79 of file SBMSurfaceMeshBuilder.h.

Referenced by initialSetup().

◆ _boundary_elements

std::vector<std::unique_ptr<SBMBndElementBase> > SBMSurfaceMeshBuilder::_boundary_elements

protected

The boundary elements are stored in a vector of unique pointers to SBMBndElementBase.

Definition at line 70 of file SBMSurfaceMeshBuilder.h.

Referenced by getBoundaryElements(), and initialSetup().

◆ _build_kd_tree

const bool SBMSurfaceMeshBuilder::_build_kd_tree

protected

whether we want to build a kd-tree or not

Definition at line 85 of file SBMSurfaceMeshBuilder.h.

Referenced by initialSetup().

◆ _centroids

std::vector<Point> SBMSurfaceMeshBuilder::_centroids

protected

The centroids of the elements in the boundary mesh are stored in a vector of Points. The sequence is the same as in _boundary_elements.

Definition at line 73 of file SBMSurfaceMeshBuilder.h.

Referenced by getCentroids(), and initialSetup().

◆ _check_watertightness

const bool SBMSurfaceMeshBuilder::_check_watertightness

protected

The flag to check the watertightness of the mesh.

Definition at line 82 of file SBMSurfaceMeshBuilder.h.

Referenced by initialSetup().

◆ _dim_embedding_mesh

const unsigned int SBMSurfaceMeshBuilder::_dim_embedding_mesh

private

The dimension of the embedding mesh (2D or 3D).

Definition at line 89 of file SBMSurfaceMeshBuilder.h.

Referenced by initialSetup().

◆ _kd_tree

std::unique_ptr<KDTree> SBMSurfaceMeshBuilder::_kd_tree

protected

The KDTree is constructed using the centroids of the elements in the boundary mesh.

Definition at line 67 of file SBMSurfaceMeshBuilder.h.

Referenced by getKDTree(), hasKDTree(), and initialSetup().

◆ _leaf_max_size

const int SBMSurfaceMeshBuilder::_leaf_max_size

protected

Configures KDTree leaf node size for performance tuning.

Definition at line 76 of file SBMSurfaceMeshBuilder.h.

Referenced by initialSetup().

◆ _mesh

std::unique_ptr<MeshBase> SBMSurfaceMeshBuilder::_mesh

protected

Holds the mesh to ensure boundary element pointers remain valid.

Avoid extracting raw MeshBase* from a function returning std::unique_ptr<MeshBase>, as it can lead to dangling pointers. Use std::unique_ptr to manage ownership safely.

Definition at line 64 of file SBMSurfaceMeshBuilder.h.

Referenced by checkWatertightness(), and initialSetup().

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

shifted_boundary_method/include/userobjects/SBMSurfaceMeshBuilder.h
shifted_boundary_method/src/userobjects/SBMSurfaceMeshBuilder.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SBMSurfaceMeshBuilder()

Member Function Documentation

◆ checkWatertightness()

◆ execute()

◆ finalize()

◆ getBoundaryElements()

◆ getCentroids()

◆ getKDTree()

◆ hasKDTree()

◆ initialize()

◆ initialSetup()

◆ validParams()

Member Data Documentation

◆ _bnd_mesh_name

◆ _boundary_elements

◆ _build_kd_tree

◆ _centroids

◆ _check_watertightness

◆ _dim_embedding_mesh

◆ _kd_tree

◆ _leaf_max_size

◆ _mesh