SBMBase< Parent > Class Template Reference

Template base providing signed-distance and normal-vector utilities for SBM objects. More...

#include <SBMBase.h>

Inheritance diagram for SBMBase< Parent >:

Public Member Functions
	SBMBase (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	initialSetup () override
virtual bool	perform_shifted () const =0
	Whether to apply shifted integration corrections.
Real	h () const
	Returns the characteristic mesh size, computed as (element_volume)^(1/dim)
const RealVectorValue	surrogateDistance () const
	Returns the shortest distance vector from the current quadrature point to the true interface.
const RealVectorValue	trueNormal () const
	Returns the true normal vector at the projected point on the true interface.

Protected Attributes
const BoundaryShortestDistanceToSurface *	_sbm_distance_uo
	user object for distance and normal calculations

Detailed Description

template<typename Parent>
class SBMBase< Parent >

Template base providing signed-distance and normal-vector utilities for SBM objects.

This mixes in with different MOOSE parents (IntegratedBC, InterfaceKernel, ... ) while sharing a single implementation.

Definition at line 26 of file SBMBase.h.

Constructor & Destructor Documentation

SBMBase()

template<typename Parent >

SBMBase< Parent >::SBMBase

(

const InputParameters &

parameters

)

Definition at line 26 of file SBMBase.C.

  : Parent(parameters), _sbm_distance_uo(nullptr)
{
}

Member Function Documentation

h()

template<typename Parent >

Real SBMBase< Parent >::h ( ) const

protected

Returns the characteristic mesh size, computed as (element_volume)^(1/dim)

Definition at line 48 of file SBMBase.C.

{
  return std::pow(this->_current_elem->volume(), 1.0 / this->_mesh.dimension());
}

initialSetup()

template<typename Parent >

void SBMBase< Parent >::initialSetup ( )

overrideprotectedvirtual

Definition at line 33 of file SBMBase.C.

{
  if (perform_shifted())
  {
    if (!this->isParamSetByUser("sbm_distance_uo"))
      mooseError("SBMBase: 'sbm_distance_uo' must be set when using shifted integration.");
    else
      _sbm_distance_uo =
          &static_cast<Parent &>(*this).template getUserObject<BoundaryShortestDistanceToSurface>(
              "sbm_distance_uo");
  }
}

perform_shifted()

template<typename Parent >

virtual bool SBMBase< Parent >::perform_shifted ( ) const

protectedpure virtual

Whether to apply shifted integration corrections.

Shifted integration is the intended SBM mode. A derived class may return false to retain the same formulation without its shifted corrections as a verification or comparison baseline.

surrogateDistance()

template<typename Parent >

const RealVectorValue SBMBase< Parent >::surrogateDistance ( ) const

protected

Returns the shortest distance vector from the current quadrature point to the true interface.

Definition at line 55 of file SBMBase.C.

{
  const auto elem_side = std::make_pair(this->_current_elem->id(), this->_current_side);
  return _sbm_distance_uo->surrogateDistance(elem_side, this->_qp);
}

trueNormal()

template<typename Parent >

const RealVectorValue SBMBase< Parent >::trueNormal ( ) const

protected

Returns the true normal vector at the projected point on the true interface.

Definition at line 63 of file SBMBase.C.

{
  const auto elem_side = std::make_pair(this->_current_elem->id(), this->_current_side);
  return _sbm_distance_uo->trueNormal(elem_side, this->_qp);
}

validParams()

template<typename Parent >

InputParameters SBMBase< Parent >::validParams ( )

static

Definition at line 15 of file SBMBase.C.

{
  InputParameters params = Parent::validParams();
  params.addParam<UserObjectName>(
      "sbm_distance_uo",
      "UserObject that provides signed distance and normal vector calculations.");
 
  return params;
}

Referenced by SCZMInterfaceKernelBaseTempl< is_ad >::validParams().

Member Data Documentation

_sbm_distance_uo

template<typename Parent >

const BoundaryShortestDistanceToSurface* SBMBase< Parent >::_sbm_distance_uo

protected

user object for distance and normal calculations

Definition at line 53 of file SBMBase.h.

---

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

• shifted_boundary_method/include/base/SBMBase.h
• shifted_boundary_method/src/base/SBMBase.C