https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
MovingPlanarFront Class Referenceabstract

Defines the position of a moving front. More...

#include <MovingPlanarFront.h>

Inheritance diagram for MovingPlanarFront:
[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

 MovingPlanarFront (const InputParameters &parameters)
 
virtual Real value (Real t, const Point &p) const override
 
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
 
virtual RealGradient gradient (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
 
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
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () 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 &nm) const
 
void paramError (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
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) 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 initialSetup ()
 
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 UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & 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 ()
 

Public Attributes

const ConsoleStream _console
 

Protected Member Functions

virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) 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
 
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
 

Protected Attributes

const RealVectorValue _start_posn
 Initial position of front. More...
 
const RealVectorValue _end_posn
 Final position of the front: together with start_posn this defines the front's normal. More...
 
const Function & _distance
 The front's distance from start_posn (along the normal direction) More...
 
const Real _active_length
 Active length. More...
 
const Real _true_value
 True value to return. More...
 
const Real _false_value
 False value to return. More...
 
const Real _activation_time
 Activation time. More...
 
const Real _deactivation_time
 Deactivation time. More...
 
RealVectorValue _front_normal
 Front unit normal. More...
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
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

Defines the position of a moving front.

The front is an infinite plane with normal pointing from start_posn to end_posn. The front's distance from start_posn is defined by the 'distance' function

This Function may be used to define the geometry of an underground excavation, probably in conjunction with a predefined sideset.

Definition at line 23 of file MovingPlanarFront.h.

Constructor & Destructor Documentation

◆ MovingPlanarFront()

MovingPlanarFront::MovingPlanarFront ( const InputParameters &  parameters)

Definition at line 56 of file MovingPlanarFront.C.

57  : Function(parameters),
58  FunctionInterface(this),
59  _start_posn(getParam<RealVectorValue>("start_posn")),
60  _end_posn(getParam<RealVectorValue>("end_posn")),
61  _distance(getFunction("distance")),
62  _active_length(getParam<Real>("active_length")),
63  _true_value(getParam<Real>("true_value")),
64  _false_value(getParam<Real>("false_value")),
65  _activation_time(getParam<Real>("activation_time")),
66  _deactivation_time(getParam<Real>("deactivation_time")),
67  _front_normal(_end_posn - _start_posn)
68 {
69  if (_front_normal.norm() == 0)
70  mooseError("MovingPlanarFront: start_posn and end_posn must be different points");
71  _front_normal /= _front_normal.norm();
72 }
MovingPlanarFront::_activation_time
const Real _activation_time
Activation time.
Definition: MovingPlanarFront.h:53
VectorValue< Real >::norm
auto norm() const -> decltype(std::norm(Real()))
FunctionInterface::FunctionInterface
FunctionInterface(const MooseObject *moose_object)
FunctionInterface::getFunction
const Function & getFunction(const std::string &name) const
MovingPlanarFront::_deactivation_time
const Real _deactivation_time
Deactivation time.
Definition: MovingPlanarFront.h:56
Function::Function
Function(const InputParameters &parameters)
MovingPlanarFront::_start_posn
const RealVectorValue _start_posn
Initial position of front.
Definition: MovingPlanarFront.h:35
MovingPlanarFront::_distance
const Function & _distance
The front&#39;s distance from start_posn (along the normal direction)
Definition: MovingPlanarFront.h:41
MovingPlanarFront::_false_value
const Real _false_value
False value to return.
Definition: MovingPlanarFront.h:50
Function::mooseError
void mooseError(Args &&... args) const
Function::parameters
const InputParameters & parameters() const
MovingPlanarFront::_true_value
const Real _true_value
True value to return.
Definition: MovingPlanarFront.h:47
MovingPlanarFront::_end_posn
const RealVectorValue _end_posn
Final position of the front: together with start_posn this defines the front&#39;s normal.
Definition: MovingPlanarFront.h:38
MovingPlanarFront::_active_length
const Real _active_length
Active length.
Definition: MovingPlanarFront.h:44
MovingPlanarFront::_front_normal
RealVectorValue _front_normal
Front unit normal.
Definition: MovingPlanarFront.h:59

Member Function Documentation

◆ validParams()

InputParameters MovingPlanarFront::validParams ( )
static

Definition at line 15 of file MovingPlanarFront.C.

16 {
17  InputParameters params = Function::validParams();
18  params.addRequiredParam<RealVectorValue>("start_posn", "Initial position of the front");
19  params.addRequiredParam<RealVectorValue>("end_posn", "Final position of the front");
20  params.addRequiredParam<FunctionName>(
21  "distance",
22  "The front is an infinite plane with normal pointing from start_posn to "
23  "end_posn. The front's distance from start_posn is defined by distance. You "
24  "should ensure that distance is positive");
25  params.addParam<Real>(
26  "active_length",
27  std::numeric_limits<Real>::max(),
28  "Points greater than active_length behind the front will return false_value");
29  params.addParam<Real>("true_value", 1.0, "Return this value if a point is in the active zone.");
30  params.addParam<Real>(
31  "false_value", 0.0, "Return this value if a point is not in the active zone.");
32  params.addParam<Real>("activation_time",
33  std::numeric_limits<Real>::lowest(),
34  "This function will return false_value when t < activation_time");
35  params.addParam<Real>("deactivation_time",
36  std::numeric_limits<Real>::max(),
37  "This function will return false_value when t >= deactivation_time");
38  params.addClassDescription(
39  "This function defines the position of a moving front. The front is "
40  "an infinite plane with normal pointing from start_posn to end_posn. The front's distance "
41  "from start_posn is defined by 'distance', so if the 'distance' function is time dependent, "
42  "the front's position will change with time. Roughly speaking, the function returns "
43  "true_value for points lying in between start_posn and start_posn + distance. Precisely "
44  "speaking, two planes are constructed, both with normal pointing from start_posn to "
45  "end_posn. The first plane passes through start_posn; the second plane passes through "
46  "end_posn. Given a point p and time t, this function returns false_value if ANY of the "
47  "following are true: (a) t<activation_time; (b) t>=deactivation_time; (c) p is 'behind' "
48  "start_posn (ie, p lies on one side of the start_posn plane and end_posn lies on the other "
49  "side); (d) p is 'ahead' of the front (ie, p lies one one side of the front and start_posn "
50  "lies on the other side); (e) the distance between p and the front is greater than "
51  "active_length. Otherwise, the point is 'in the active zone' and the function returns "
52  "true_value.");
53  return params;
54 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
Function::validParams
static InputParameters validParams()

◆ value() [1/9]

virtual Real Function::value

◆ value() [2/9]

auto Function::value

◆ value() [3/9]

auto Function::value

◆ value() [4/9]

auto Function::value

◆ value() [5/9]

ChainedReal Function::value

◆ value() [6/9]

ChainedReal Function::value

◆ value() [7/9]

auto Function::value

◆ value() [8/9]

virtual ADReal Function::value

◆ value() [9/9]

Real MovingPlanarFront::value ( Real  t,
const Point &  p 
) const
overridevirtual

Reimplemented from Function.

Definition at line 75 of file MovingPlanarFront.C.

76 {
77  if (t < _activation_time)
78  return _false_value;
79 
80  if (t >= _deactivation_time)
81  return _false_value;
82 
83  if ((p - _start_posn) * _front_normal < 0)
84  // point is behind start posn - it'll never be active
85  return _false_value;
86 
87  const RealVectorValue current_posn = _start_posn + _distance.value(t, p) * _front_normal;
88 
89  const Real distance_ahead_of_front = (p - current_posn) * _front_normal;
90 
91  if (distance_ahead_of_front > 0)
92  return _false_value;
93 
94  if (distance_ahead_of_front < -_active_length)
95  // point is too far behind front
96  return _false_value;
97 
98  return _true_value;
99 }
MovingPlanarFront::_activation_time
const Real _activation_time
Activation time.
Definition: MovingPlanarFront.h:53
MovingPlanarFront::_deactivation_time
const Real _deactivation_time
Deactivation time.
Definition: MovingPlanarFront.h:56
MovingPlanarFront::_start_posn
const RealVectorValue _start_posn
Initial position of front.
Definition: MovingPlanarFront.h:35
MovingPlanarFront::_distance
const Function & _distance
The front&#39;s distance from start_posn (along the normal direction)
Definition: MovingPlanarFront.h:41
MovingPlanarFront::_false_value
const Real _false_value
False value to return.
Definition: MovingPlanarFront.h:50
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
MovingPlanarFront::_true_value
const Real _true_value
True value to return.
Definition: MovingPlanarFront.h:47
Function::value
virtual Real value(Real t, const Point &p) const
MovingPlanarFront::_active_length
const Real _active_length
Active length.
Definition: MovingPlanarFront.h:44
MovingPlanarFront::_front_normal
RealVectorValue _front_normal
Front unit normal.
Definition: MovingPlanarFront.h:59

Member Data Documentation

◆ _activation_time

const Real MovingPlanarFront::_activation_time
protected

Activation time.

Definition at line 53 of file MovingPlanarFront.h.

Referenced by value().

◆ _active_length

const Real MovingPlanarFront::_active_length
protected

Active length.

Definition at line 44 of file MovingPlanarFront.h.

Referenced by value().

◆ _deactivation_time

const Real MovingPlanarFront::_deactivation_time
protected

Deactivation time.

Definition at line 56 of file MovingPlanarFront.h.

Referenced by value().

◆ _distance

const Function& MovingPlanarFront::_distance
protected

The front's distance from start_posn (along the normal direction)

Definition at line 41 of file MovingPlanarFront.h.

Referenced by value().

◆ _end_posn

const RealVectorValue MovingPlanarFront::_end_posn
protected

Final position of the front: together with start_posn this defines the front's normal.

Definition at line 38 of file MovingPlanarFront.h.

◆ _false_value

const Real MovingPlanarFront::_false_value
protected

False value to return.

Definition at line 50 of file MovingPlanarFront.h.

Referenced by value().

◆ _front_normal

RealVectorValue MovingPlanarFront::_front_normal
protected

Front unit normal.

Definition at line 59 of file MovingPlanarFront.h.

Referenced by MovingPlanarFront(), and value().

◆ _start_posn

const RealVectorValue MovingPlanarFront::_start_posn
protected

Initial position of front.

Definition at line 35 of file MovingPlanarFront.h.

Referenced by value().

◆ _true_value

const Real MovingPlanarFront::_true_value
protected

True value to return.

Definition at line 47 of file MovingPlanarFront.h.

Referenced by value().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:48:57 for https://mooseframework.inl.gov by   doxygen 1.8.14