This layered user object computes the change in cross sectional area of a flow channel. More...

#include <LayeredFlowAreaChange.h>

Inheritance diagram for LayeredFlowAreaChange:

Public Types
typedef FunctorBase< Real >	FunctorType

typedef Real	ValueType

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

typedef ValueType	DotType

Public Member Functions
	LayeredFlowAreaChange (const InputParameters &parameters)

virtual Real	spatialValue (const Point &p) const override
	Given a Point return the integral value associated with the layer that point falls in. More...

virtual void	initialize () override

virtual void	execute () override

virtual void	finalize () override

virtual void	threadJoin (const UserObject &y) override

virtual Real	computeIntegral () override

virtual bool	hasBlocks (SubdomainID sub) const override

Real	evaluateTemplate (const SpatialArg &position, const Moose::StateArg &libmesh_dbg_var(state)) const

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

const MooseFunctorName &	functorName () const

virtual void	residualSetup () override

virtual void	jacobianSetup () override

virtual void	timestepSetup () override

virtual void	customSetup (const ExecFlagType &exec_type) override

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

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

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

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

virtual Real	integralValue (const Point &p) const

virtual Real	getLayerValue (unsigned int layer) const

virtual unsigned int	getLayer (const Point &p) const

const std::vector< Real > &	getLayerCenters () const

unsigned int	direction () const

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
typedef Moose::ElemArg	ElemArg

typedef Moose::ElemQpArg	ElemQpArg

typedef Moose::ElemSideQpArg	ElemSideQpArg

typedef Moose::FaceArg	FaceArg

typedef Moose::ElemPointArg	ElemPointArg

typedef Moose::NodeArg	NodeArg

Protected Member Functions
virtual Real	computeQpIntegral () override

virtual Real	evaluate (const ElemArg &elem, const Moose::StateArg &state) const override

virtual Real	evaluate (const FaceArg &face, const Moose::StateArg &state) const override final

virtual Real	evaluate (const ElemQpArg &qp, const Moose::StateArg &state) const override

virtual Real	evaluate (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final

virtual Real	evaluate (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final

virtual Real	evaluate (const NodeArg &node, const Moose::StateArg &state) const override final

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 bool	supportsFaceArg () const override final

virtual bool	supportsElemSideQpArg () const override final

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

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

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

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

void	setLayerValue (unsigned int layer, Real value)

bool	layerHasValue (unsigned int layer) const

void	getBounds ()

void	computeLayerCenters ()

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

Protected Attributes
unsigned int	_dim
	the problem dimension More...

std::vector< const VariableValue * >	_disp
	the displacement vectors More...

std::string	_layered_base_name

const InputParameters &	_layered_base_params

MooseEnum	_direction_enum

unsigned int	_direction

bool	_interval_based

unsigned int	_num_layers

std::vector< Real >	_layer_bounds

unsigned int	_sample_type

unsigned int	_average_radius

bool	_using_displaced_mesh

std::vector< Real >	_layer_centers

Real	_direction_min

Real	_direction_max

std::vector< Real > &	_layer_values

std::vector< int > &	_layer_has_value

bool	_cumulative

const bool	_positive_cumulative_direction

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

Detailed Description

This layered user object computes the change in cross sectional area of a flow channel.

Definition at line 20 of file LayeredFlowAreaChange.h.

Constructor & Destructor Documentation

◆ LayeredFlowAreaChange()

LayeredFlowAreaChange::LayeredFlowAreaChange ( const InputParameters & parameters )

Definition at line 36 of file LayeredFlowAreaChange.C.

   : SpatialUserObjectFunctor<SideIntegralUserObject>(parameters),
     LayeredBase(parameters),
     _dim(_mesh.dimension())
 {
   if (coupledComponents("displacements") != _dim)
     paramError("displacements",
                "The number of displacement components must be equal to the mesh displacement.");
 
   _disp.resize(_dim);
   for (unsigned int j = 0; j < _dim; ++j)
     _disp[j] = &coupledValue("displacements", j);
 }

Member Function Documentation

◆ computeIntegral()

Real LayeredFlowAreaChange::computeIntegral ( )

overridevirtual

Definition at line 69 of file LayeredFlowAreaChange.C.

Referenced by execute().

 {
   Real sum = 0;
   for (_qp = 0; _qp < _qrule->n_points(); _qp++)
     sum += _JxW[_qp] * _coord[_qp] * computeQpIntegral();
 
   return sum;
 }

◆ computeQpIntegral()

Real LayeredFlowAreaChange::computeQpIntegral ( )

overrideprotectedvirtual

Definition at line 79 of file LayeredFlowAreaChange.C.

Referenced by computeIntegral().

 {
   RealVectorValue displacements;
   for (unsigned int j = 0; j < _dim; ++j)
     displacements(j) = (*_disp[j])[_qp];
   return -_normals[_qp] * displacements;
 }

◆ execute()

void LayeredFlowAreaChange::execute ( )

overridevirtual

Definition at line 58 of file LayeredFlowAreaChange.C.

 {
   unsigned int layer = getLayer(_current_elem->vertex_average());
   Real height = _interval_based ? (_direction_max - _direction_min) / _num_layers
                                 : _layer_bounds[layer + 1] - _layer_bounds[layer];
   Real integral_value = computeIntegral() / height;
 
   setLayerValue(layer, getLayerValue(layer) + integral_value);
 }

◆ finalize()

void LayeredFlowAreaChange::finalize ( )

overridevirtual

Reimplemented from LayeredBase.

Definition at line 88 of file LayeredFlowAreaChange.C.

 {
   LayeredBase::finalize();
 }

◆ initialize()

void LayeredFlowAreaChange::initialize ( )

overridevirtual

Reimplemented from LayeredBase.

Definition at line 51 of file LayeredFlowAreaChange.C.

 {
   SpatialUserObjectFunctor<SideIntegralUserObject>::initialize();
   LayeredBase::initialize();
 }

◆ spatialValue()

virtual Real LayeredFlowAreaChange::spatialValue ( const Point & p ) const

inlineoverridevirtual

Given a Point return the integral value associated with the layer that point falls in.

Parameters

p	The point to look for in the layers.

Definition at line 31 of file LayeredFlowAreaChange.h.

31 { return integralValue(p); }

LayeredBase::integralValue

virtual Real integralValue(const Point &p) const

◆ threadJoin()

void LayeredFlowAreaChange::threadJoin ( const UserObject & y )

overridevirtual

Reimplemented from LayeredBase.

Definition at line 94 of file LayeredFlowAreaChange.C.

 {
   SpatialUserObjectFunctor<SideIntegralUserObject>::threadJoin(y);
   LayeredBase::threadJoin(y);
 }

◆ validParams()

InputParameters LayeredFlowAreaChange::validParams ( )

static

Definition at line 15 of file LayeredFlowAreaChange.C.

 {
   InputParameters params = SpatialUserObjectFunctor<SideIntegralUserObject>::validParams();
   params += LayeredBase::validParams();
   params.addRequiredCoupledVar("displacements",
                                "Displacements, size must match problem dimension.");
 
   // this layered object should not be used on the displaced mesh
   // because it measures deviation from the undisplaced mesh
   params.suppressParameter<bool>("use_displaced_mesh");
   params.set<bool>("use_displaced_mesh") = false;
   params.suppressParameter<std::vector<SubdomainName>>("block");
 
   params.addClassDescription(
       "This layered user object computes the change in cross sectional area "
       "of a flow channel from the displacement variables. Note: the convention is"
       "that reduction in flow area is negative. For this to be satisfied, normals must"
       "point INTO the flow channel.");
   return params;
 }

Member Data Documentation

◆ _dim

unsigned int LayeredFlowAreaChange::_dim

protected

the problem dimension

Definition at line 43 of file LayeredFlowAreaChange.h.

Referenced by computeQpIntegral(), and LayeredFlowAreaChange().

◆ _disp

std::vector<const VariableValue *> LayeredFlowAreaChange::_disp

protected

the displacement vectors

Definition at line 46 of file LayeredFlowAreaChange.h.

Referenced by computeQpIntegral(), and LayeredFlowAreaChange().

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

thermal_hydraulics/include/userobjects/LayeredFlowAreaChange.h
thermal_hydraulics/src/userobjects/LayeredFlowAreaChange.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LayeredFlowAreaChange()

Member Function Documentation

◆ computeIntegral()

◆ computeQpIntegral()

◆ execute()

◆ finalize()

◆ initialize()

◆ spatialValue()

◆ threadJoin()

◆ validParams()

Member Data Documentation

◆ _dim

◆ _disp