Computes the unsigned distance to a surface mesh using KDTree nearest neighbor lookup from SBMSurfaceMeshBuilder. More...

#include <UnsignedDistanceToSurfaceMesh.h>

Inheritance diagram for UnsignedDistanceToSurfaceMesh:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

typedef FunctorBase< Real >	FunctorType

typedef Real	ValueType

typedef typename FunctorReturnType< Real, FunctorEvaluationKind::Gradient >::type	GradientType

typedef ValueType	DotType

Public Member Functions
virtual void	initialSetup () override

	UnsignedDistanceToSurfaceMesh (const InputParameters &parameters)

const SBMBndElementBase &	closestBoundaryElem (const Point &p) const
	find closest boundary element using KDTree More...

RealVectorValue	distanceVectorToSurface (const Point &p) const
	find closest boundary element and return its distance vector More...

Real	value (Real t, const Point &p) const override
	Return unsigned distance value. More...

RealGradient	gradient (Real t, const Point &p) const override
	Return the spatial gradient of the unsigned distance function. More...

RealVectorValue	surfaceNormal (const Point &p) const
	Return the true boundary surface normal evaluated at the closest point obtained by projecting the query point onto the true boundary. More...

virtual Real	value (Real t, const Point &p) const

virtual ADReal	value (const ADReal &t, const ADPoint &p) const

ChainedReal	value (const ChainedReal &t) const

auto	value (const U &t) const

auto	value (const U &t, const U &x, const U &y=0, const U &z=0) const

ChainedReal	value (const ChainedReal &t) const

auto	value (const U &t) const

auto	value (const U &t, const U &x, const U &y=0, const U &z=0) const

virtual ADReal	value (const ADReal &t, const ADPoint &p) const

ChainedReal	value (const ChainedReal &t) const

auto	value (const U &t) const

auto	value (const U &t, const U &x, const U &y=0, const U &z=0) const

virtual RealVectorValue	vectorValue (Real t, const Point &p) const

virtual RealVectorValue	curl (Real t, const Point &p) const

virtual Real	div (Real t, const Point &p) const

GradientType	gradient (const ElemArg &elem, const StateArg &state) const

GradientType	gradient (const FaceArg &face, const StateArg &state) const

GradientType	gradient (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradient (const NodeArg &node, const StateArg &state) const

GradientType	gradient (const ElemArg &elem, const StateArg &state) const

GradientType	gradient (const FaceArg &face, const StateArg &state) const

GradientType	gradient (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradient (const NodeArg &node, const StateArg &state) const

virtual Real	timeDerivative (Real t, const Point &p) const

auto	timeDerivative (const U &t) const

auto	timeDerivative (const U &t, const U &x, const U &y=0, const U &z=0) const

auto	timeDerivative (const U &t) const

auto	timeDerivative (const U &t, const U &x, const U &y=0, const U &z=0) const

virtual Real	integral () const

virtual Real	average () const

virtual Real	timeIntegral (Real t1, Real t2, const Point &p) const

void	timestepSetup () override

void	residualSetup () override final

void	jacobianSetup () override final

void	customSetup (const ExecFlagType &exec_type) override final

bool	hasBlocks (SubdomainID) const override

bool	supportsFaceArg () const override final

bool	supportsElemSideQpArg () const override final

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	subdomainSetup ()

const ExecFlagEnum &	getExecuteOnEnum () const

bool	isImplicit ()

Moose::StateArg	determineState () 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

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

virtual void	meshChanged ()

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

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

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

FunctorReturnType< Real, FET >::type	genericEvaluate (const Space &r, const State &state) const

const MooseFunctorName &	functorName () const

void	setCacheClearanceSchedule (const std::set< ExecFlagType > &clearance_schedule)

virtual bool	isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const

bool	isInternalFace (const FaceInfo &) const

virtual bool	isConstant () const

virtual bool	hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override

void	checkFace (const Moose::FaceArg &face) const

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

ValueType	operator() (const ElemArg &elem, const StateArg &state) const

ValueType	operator() (const FaceArg &face, const StateArg &state) const

ValueType	operator() (const ElemQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemSideQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemPointArg &elem_point, const StateArg &state) const

ValueType	operator() (const NodeArg &node, const StateArg &state) const

ValueType	operator() (const ElemArg &elem, const StateArg &state) const

ValueType	operator() (const FaceArg &face, const StateArg &state) const

ValueType	operator() (const ElemQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemSideQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemPointArg &elem_point, const StateArg &state) const

ValueType	operator() (const NodeArg &node, const StateArg &state) const

ValueType	operator() (const ElemArg &elem, const StateArg &state) const

ValueType	operator() (const FaceArg &face, const StateArg &state) const

ValueType	operator() (const ElemQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemSideQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemPointArg &elem_point, const StateArg &state) const

ValueType	operator() (const NodeArg &node, const StateArg &state) const

DotType	dot (const ElemArg &elem, const StateArg &state) const

DotType	dot (const FaceArg &face, const StateArg &state) const

DotType	dot (const ElemQpArg &qp, const StateArg &state) const

DotType	dot (const ElemSideQpArg &qp, const StateArg &state) const

DotType	dot (const ElemPointArg &elem_point, const StateArg &state) const

DotType	dot (const NodeArg &node, const StateArg &state) const

DotType	dot (const ElemArg &elem, const StateArg &state) const

DotType	dot (const FaceArg &face, const StateArg &state) const

DotType	dot (const ElemQpArg &qp, const StateArg &state) const

DotType	dot (const ElemSideQpArg &qp, const StateArg &state) const

DotType	dot (const ElemPointArg &elem_point, const StateArg &state) const

DotType	dot (const NodeArg &node, const StateArg &state) const

DotType	dot (const ElemArg &elem, const StateArg &state) const

DotType	dot (const FaceArg &face, const StateArg &state) const

DotType	dot (const ElemQpArg &qp, const StateArg &state) const

DotType	dot (const ElemSideQpArg &qp, const StateArg &state) const

DotType	dot (const ElemPointArg &elem_point, const StateArg &state) const

DotType	dot (const NodeArg &node, const StateArg &state) const

GradientType	gradDot (const ElemArg &elem, const StateArg &state) const

GradientType	gradDot (const FaceArg &face, const StateArg &state) const

GradientType	gradDot (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradDot (const NodeArg &node, const StateArg &state) const

GradientType	gradDot (const ElemArg &elem, const StateArg &state) const

GradientType	gradDot (const FaceArg &face, const StateArg &state) const

GradientType	gradDot (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradDot (const NodeArg &node, const StateArg &state) const

GradientType	gradDot (const ElemArg &elem, const StateArg &state) const

GradientType	gradDot (const FaceArg &face, const StateArg &state) const

GradientType	gradDot (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradDot (const NodeArg &node, const StateArg &state) 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)

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

Protected Member Functions
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

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

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

virtual void	addUserObjectDependencyHelper (const UserObjectBase &) 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

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 GradientType	evaluateGradDot (const ElemArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const FaceArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemSideQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemPointArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const NodeArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const FaceArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemSideQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemPointArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const NodeArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const FaceArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemSideQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemPointArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const NodeArg &, const StateArg &) const

virtual ValueType	evaluate (const ElemArg &elem, const StateArg &state) const =0

virtual ValueType	evaluate (const FaceArg &face, const StateArg &state) const =0

virtual ValueType	evaluate (const ElemQpArg &qp, const StateArg &state) const =0

virtual ValueType	evaluate (const ElemSideQpArg &side_qp, const StateArg &state) const =0

virtual ValueType	evaluate (const ElemPointArg &elem_point, const StateArg &state) const =0

virtual ValueType	evaluate (const NodeArg &node, const StateArg &state) const =0

virtual GradientType	evaluateGradient (const ElemArg &, const StateArg &) const

virtual GradientType	evaluateGradient (const FaceArg &, const StateArg &) const

virtual GradientType	evaluateGradient (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradient (const ElemSideQpArg &, const StateArg &) const

virtual GradientType	evaluateGradient (const ElemPointArg &, const StateArg &) const

virtual GradientType	evaluateGradient (const NodeArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemArg &, const StateArg &) const

virtual DotType	evaluateDot (const FaceArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemQpArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemSideQpArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemPointArg &, const StateArg &) const

virtual DotType	evaluateDot (const NodeArg &, const StateArg &) const

Protected Attributes
KDTree *	_kd_tree
	Cached pointers for speed. More...

const std::vector< std::unique_ptr< SBMBndElementBase > > *	_boundary_elements

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

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

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

const Parallel::Communicator &	_communicator

Detailed Description

Computes the unsigned distance to a surface mesh using KDTree nearest neighbor lookup from SBMSurfaceMeshBuilder.

The gradient returns the unit vector pointing from the boundary element to the query point.

Definition at line 24 of file UnsignedDistanceToSurfaceMesh.h.

Constructor & Destructor Documentation

◆ UnsignedDistanceToSurfaceMesh()

UnsignedDistanceToSurfaceMesh::UnsignedDistanceToSurfaceMesh ( const InputParameters & parameters )

Definition at line 29 of file UnsignedDistanceToSurfaceMesh.C.

   : Function(parameters)
 {
 }

Member Function Documentation

◆ closestBoundaryElem()

const SBMBndElementBase & UnsignedDistanceToSurfaceMesh::closestBoundaryElem ( const Point & p ) const

find closest boundary element using KDTree

Definition at line 51 of file UnsignedDistanceToSurfaceMesh.C.

Referenced by distanceVectorToSurface(), and surfaceNormal().

 {
   // KDTree nearest neighbor search
   std::vector<std::size_t> ret_index(1);
   _kd_tree->neighborSearch(p, 1, ret_index);
 
   return *_boundary_elements->at(ret_index.front()).get();
 }

◆ distanceVectorToSurface()

RealVectorValue UnsignedDistanceToSurfaceMesh::distanceVectorToSurface ( const Point & p ) const

find closest boundary element and return its distance vector

Definition at line 61 of file UnsignedDistanceToSurfaceMesh.C.

Referenced by gradient(), and value().

 {
   const SBMBndElementBase & elem = closestBoundaryElem(p);
   return elem.distanceFrom(p);
 }

◆ gradient()

RealGradient UnsignedDistanceToSurfaceMesh::gradient	(	Real	t,
		const Point &	p
	)		const

overridevirtual

Return the spatial gradient of the unsigned distance function.

The gradient is a unit vector pointing in the direction of decreasing distance, i.e., from the query point toward the closest point on the surface.

Reimplemented from Function.

Definition at line 74 of file UnsignedDistanceToSurfaceMesh.C.

 {
   const RealVectorValue dv = distanceVectorToSurface(p);
   const Real dist = dv.norm();
 
   if (dist <= libMesh::TOLERANCE)
     return RealGradient(0, 0, 0);
 
   // dv points from the query point toward the nearest surface, so -dv points away from it.
   // The gradient of a distance field points toward increasing distance (away from the surface),
   // matching the signed-distance gradient convention used by SBMUtils::distanceVectorFromFunction.
   return -dv / dist;
 }

◆ initialSetup()

void UnsignedDistanceToSurfaceMesh::initialSetup ( )

overridevirtual

Reimplemented from Function.

Definition at line 35 of file UnsignedDistanceToSurfaceMesh.C.

 {
   const auto builder = &getUserObject<SBMSurfaceMeshBuilder>("builder");
 
   if (!builder->hasKDTree())
     mooseError("UnsignedDistanceToSurfaceMesh '",
                name(),
                "' requires SBMSurfaceMeshBuilder '",
                builder->name(),
                "' to be configured with 'build_kd_tree = true'.");
 
   _kd_tree = &builder->getKDTree();
   _boundary_elements = &builder->getBoundaryElements();
 }

◆ surfaceNormal()

RealVectorValue UnsignedDistanceToSurfaceMesh::surfaceNormal ( const Point & p ) const

Return the true boundary surface normal evaluated at the closest point obtained by projecting the query point onto the true boundary.

Definition at line 89 of file UnsignedDistanceToSurfaceMesh.C.

 {
   const SBMBndElementBase & elem = closestBoundaryElem(p);
 
   RealVectorValue n = elem.normal();
   const Real n_norm = n.norm();
 
   return n / n_norm;
 }

◆ validParams()

InputParameters UnsignedDistanceToSurfaceMesh::validParams ( )

static

Definition at line 17 of file UnsignedDistanceToSurfaceMesh.C.

 {
   InputParameters params = Function::validParams();
   params.addRequiredParam<UserObjectName>(
       "builder", "SBMSurfaceMeshBuilder that provides KDTree, elem_id_map, and boundary elements.");
 
   params.addClassDescription(
       "Returns unsigned distance to a surface mesh using KDTree nearest neighbor search. "
       "The gradient returns the unit vector pointing from boundary to query point.");
   return params;
 }

◆ value() [1/9]

virtual Real Function::value

◆ value() [2/9]

ChainedReal Function::value

◆ value() [3/9]

auto Function::value

◆ value() [4/9]

auto Function::value

◆ value() [5/9]

ChainedReal Function::value

◆ value() [6/9]

virtual ADReal Function::value

◆ value() [7/9]

auto Function::value

◆ value() [8/9]

auto Function::value

◆ value() [9/9]

Real UnsignedDistanceToSurfaceMesh::value	(	Real	t,
		const Point &	p
	)		const

overridevirtual

Return unsigned distance value.

Reimplemented from Function.

Definition at line 68 of file UnsignedDistanceToSurfaceMesh.C.

 {
   return distanceVectorToSurface(p).norm();
 }

Member Data Documentation

◆ _boundary_elements

const std::vector<std::unique_ptr<SBMBndElementBase> >* UnsignedDistanceToSurfaceMesh::_boundary_elements

protected

Definition at line 56 of file UnsignedDistanceToSurfaceMesh.h.

Referenced by closestBoundaryElem(), and initialSetup().

◆ _kd_tree

KDTree* UnsignedDistanceToSurfaceMesh::_kd_tree

protected

Cached pointers for speed.

Definition at line 55 of file UnsignedDistanceToSurfaceMesh.h.

Referenced by closestBoundaryElem(), and initialSetup().

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

shifted_boundary_method/include/functions/UnsignedDistanceToSurfaceMesh.h
shifted_boundary_method/src/functions/UnsignedDistanceToSurfaceMesh.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ UnsignedDistanceToSurfaceMesh()

Member Function Documentation

◆ closestBoundaryElem()

◆ distanceVectorToSurface()

◆ gradient()

◆ initialSetup()

◆ surfaceNormal()

◆ validParams()

◆ value() [1/9]

◆ value() [2/9]

◆ value() [3/9]

◆ value() [4/9]

◆ value() [5/9]

◆ value() [6/9]

◆ value() [7/9]

◆ value() [8/9]

◆ value() [9/9]

Member Data Documentation

◆ _boundary_elements

◆ _kd_tree