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

Class implementing a symmetry boundary condition for the velocity variable. More...

#include <LinearFVVelocitySymmetryBC.h>

Inheritance diagram for LinearFVVelocitySymmetryBC:
[legend]

Public Types

enum  TEST_TYPE
 
enum  ResidualTagType { ResidualTagType::NonReference, ResidualTagType::Reference }
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 LinearFVVelocitySymmetryBC (const InputParameters &parameters)
 Class constructor. More...
 
virtual Real computeBoundaryValue () const override
 Overriding all of these. More...
 
virtual Real computeBoundaryNormalGradient () const override
 
virtual Real computeBoundaryValueMatrixContribution () const override
 
virtual Real computeBoundaryValueRHSContribution () const override
 
virtual Real computeBoundaryGradientMatrixContribution () const override
 
virtual Real computeBoundaryGradientRHSContribution () const override
 
virtual bool includesMaterialPropertyMultiplier () const
 
virtual bool useBoundaryGradientExtrapolation () const
 
virtual bool hasFaceSide (const FaceInfo &fi, bool fi_elem_side) const override
 
const SubProblem & subProblem () const
 
const MooseLinearVariableFV< Real > & variable () const
 
void setupFaceData (const FaceInfo *face_info, const FaceInfo::VarFaceNeighbors face_type)
 
const FaceInfo * currentFaceInfo () const
 
FaceInfo::VarFaceNeighbors currentFaceType () 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 haveParameter (const std::string &name) 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 const std::set< BoundaryID > & boundaryIDs () const
 
const std::vector< BoundaryName > & boundaryNames () const
 
unsigned int numBoundaryIDs () const
 
bool hasBoundary (const BoundaryName &name) const
 
bool hasBoundary (const std::vector< BoundaryName > &names) const
 
bool hasBoundary (const BoundaryID &id) const
 
bool hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool isBoundarySubset (const std::set< BoundaryID > &ids) const
 
bool isBoundarySubset (const std::vector< BoundaryID > &ids) const
 
bool hasBoundaryMaterialProperty (const std::string &prop_name) const
 
virtual bool boundaryRestricted () const
 
const std::set< BoundaryID > & meshBoundaryIDs () const
 
virtual bool checkVariableBoundaryIntegrity () const
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () 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
 
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
 
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
 
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
 
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
 
PenetrationLocator & getPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
PenetrationLocator & getQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
NearestNodeLocator & getNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
 
NearestNodeLocator & getQuadratureNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
 
bool requiresGeometricSearch () const
 
virtual void meshChanged ()
 
void useVectorTag (const TagName &tag_name, VectorTagsKey)
 
void useVectorTag (TagID tag_id, VectorTagsKey)
 
void useMatrixTag (const TagName &tag_name, MatrixTagsKey)
 
void useMatrixTag (TagID tag_id, MatrixTagsKey)
 
bool isVectorTagged ()
 
bool isMatrixTagged ()
 
bool hasVectorTags () const
 
const std::set< TagID > & getVectorTags (VectorTagsKey) const
 
const std::set< TagID > & getMatrixTags (MatrixTagsKey) const
 
MooseVariableBase * mooseVariableBase () const
 
MooseVariableField< Real > & mooseVariableField ()
 
MooseVariableFE< Real > * mooseVariable () const
 
MooseVariableFV< Real > * mooseVariableFV () const
 
MooseLinearVariableFV< Real > * mooseLinearVariableFV () const
 
const std::set< MooseVariableFieldBase *> & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase *> checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
std::set< MooseVariableFieldBase *> checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
Moose::FaceArg makeFace (const FaceInfo &fi, const Moose::FV::LimiterType limiter_type, const bool elem_is_upwind, const bool correct_skewness=false, const Moose::StateArg *state_limiter=nullptr) const
 
Moose::FaceArg makeCDFace (const FaceInfo &fi, const bool correct_skewness=false) 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
 
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 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 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 bool restricted (const std::set< BoundaryID > &ids)
 
static std::string deduceFunctorName (const std::string &name, const InputParameters &params)
 

Public Attributes

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

std::string deduceFunctorName (const std::string &name) const
 
Real computeCellToFaceDistance () const
 
RealVectorValue computeCellToFaceVector () const
 
Moose::FaceArg singleSidedFaceArg (const FaceInfo *fi, Moose::FV::LimiterType limiter_type=Moose::FV::LimiterType::CentralDifference, bool correct_skewness=false) const
 
Moose::FaceArg functorFaceArg (const FunctorType &functor, const FaceInfo *fi, Moose::FV::LimiterType limiter_type=Moose::FV::LimiterType::CentralDifference, bool correct_skewness=false) const
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
bool hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
 
KOKKOS_FUNCTION dof_id_type numKokkosBoundaryNodes () const
 
KOKKOS_FUNCTION dof_id_type numKokkosBoundarySides () const
 
KOKKOS_FUNCTION ContiguousNodeID kokkosBoundaryNodeID (Moose::Kokkos::ThreadID tid) const
 
KOKKOS_FUNCTION auto kokkosBoundaryElementSideID (Moose::Kokkos::ThreadID tid) const
 
virtual void addUserObjectDependencyHelper (const UserObjectBase &) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTagLower (Assembly &assembly, unsigned int ivar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const
 
void prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const
 
void prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)
 
void accumulateTaggedLocalResidual ()
 
void assignTaggedLocalResidual ()
 
void accumulateTaggedLocalMatrix ()
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)
 
void accumulateTaggedNonlocalMatrix ()
 
void assignTaggedLocalMatrix ()
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
 
void addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const ADResidualsPacket &packet)
 
void addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
 
void addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)
 
void addResidualsWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)
 
void setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)
 
void setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)
 
void setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)
 
virtual const OutputTools< Real >::VariableValue & value ()
 
virtual const OutputTools< Real >::VariableValue & valueOld ()
 
virtual const OutputTools< Real >::VariableValue & valueOlder ()
 
virtual const OutputTools< Real >::VariableValue & dot ()
 
virtual const OutputTools< Real >::VariableValue & dotDot ()
 
virtual const OutputTools< Real >::VariableValue & dotOld ()
 
virtual const OutputTools< Real >::VariableValue & dotDotOld ()
 
virtual const VariableValue & dotDu ()
 
virtual const VariableValue & dotDotDu ()
 
virtual const OutputTools< Real >::VariableGradient & gradient ()
 
virtual const OutputTools< Real >::VariableGradient & gradientOld ()
 
virtual const OutputTools< Real >::VariableGradient & gradientOlder ()
 
virtual const OutputTools< Real >::VariableSecond & second ()
 
virtual const OutputTools< Real >::VariableSecond & secondOld ()
 
virtual const OutputTools< Real >::VariableSecond & secondOlder ()
 
virtual const OutputTools< Real >::VariableTestSecond & secondTest ()
 
virtual const OutputTools< Real >::VariableTestSecond & secondTestFace ()
 
virtual const OutputTools< Real >::VariablePhiSecond & secondPhi ()
 
virtual const OutputTools< Real >::VariablePhiSecond & secondPhiFace ()
 
const Moose::Functor< T > & getFunctor (const std::string &name)
 
const Moose::Functor< T > & getFunctor (const std::string &name, THREAD_ID tid)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
 
bool isFunctor (const std::string &name) const
 
bool isFunctor (const std::string &name, const SubProblem &subproblem) const
 
Moose::ElemArg makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
 
void checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
 
const Moose::Functor< T > & getFunctorByName (const std::string &name)
 

Protected Attributes

const unsigned int _dim
 The dimension of the mesh. More...
 
const MooseLinearVariableFVReal *const _u_var
 Velocity in direction x. More...
 
const MooseLinearVariableFVReal *const _v_var
 Velocity in direction y. More...
 
const MooseLinearVariableFVReal *const _w_var
 Velocity in direction z. More...
 
std::vector< const MooseLinearVariableFVReal * > _vel_vars
 For convenience we organize the velocity variables in a vector. More...
 
const unsigned int _index
 Index x|y|z, this is mainly to handle the deviatoric parts correctly in in the stress term. More...
 
const THREAD_ID _tid
 
SubProblem & _subproblem
 
MooseMesh & _mesh
 
FEProblemBase & _fv_problem
 
MooseLinearVariableFV< Real > & _var
 
SystemBase & _sys
 
const FaceInfo * _current_face_info
 
FaceInfo::VarFaceNeighbors _current_face_type
 
const unsigned int _var_num
 
const unsigned int _sys_num
 
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
 
GeometricSearchData & _geometric_search_data
 
bool _requires_geometric_search
 
FEProblemBase & _mci_feproblem
 
DenseVector< Number > _local_re
 
DenseMatrix< Number > _local_ke
 
DenseMatrix< Number > _nonlocal_ke
 
bool _nodal
 
MooseVariableFE< Real > * _variable
 
MooseVariableFV< Real > * _fv_variable
 
MooseLinearVariableFV< Real > * _linear_fv_variable
 
MooseVariableField< Real > * _field_variable
 
Assembly * _mvi_assembly
 
const Parallel::Communicator & _communicator
 

Detailed Description

Class implementing a symmetry boundary condition for the velocity variable.

The implementation is based on the method discussed in: {greenshieldsweller2022, title = "Notes on Computational Fluid Dynamics: General Principles", author = "Greenshields, Christopher and Weller, Henry", year = 2022, publisher = "CFD Direct Ltd", address = "Reading, UK" }

Definition at line 25 of file LinearFVVelocitySymmetryBC.h.

Constructor & Destructor Documentation

◆ LinearFVVelocitySymmetryBC()

LinearFVVelocitySymmetryBC::LinearFVVelocitySymmetryBC ( const InputParameters &  parameters)

Class constructor.

Parameters
parametersThe InputParameters for the object

Definition at line 32 of file LinearFVVelocitySymmetryBC.C.

33  : LinearFVAdvectionDiffusionBC(parameters),
34  _dim(_subproblem.mesh().dimension()),
35  _u_var(dynamic_cast<const MooseLinearVariableFVReal *>(
36  &_fv_problem.getVariable(_tid, getParam<SolverVariableName>("u")))),
37  _v_var(parameters.isParamValid("v")
38  ? dynamic_cast<const MooseLinearVariableFVReal *>(
39  &_fv_problem.getVariable(_tid, getParam<SolverVariableName>("v")))
40  : nullptr),
41  _w_var(parameters.isParamValid("w")
42  ? dynamic_cast<const MooseLinearVariableFVReal *>(
43  &_fv_problem.getVariable(_tid, getParam<SolverVariableName>("w")))
44  : nullptr),
45  _index(getParam<MooseEnum>("momentum_component"))
46 {
47  if (!_u_var)
48  paramError("u", "the u velocity must be a MooseLinearVariableFVReal.");
49 
50  _vel_vars.push_back(_u_var);
51 
52  if (_dim >= 2 && !_v_var)
53  paramError("v",
54  "In two or more dimensions, the v velocity must be supplied and it must be a "
55  "MooseLinearVariableFVReal.");
56 
57  _vel_vars.push_back(_v_var);
58 
59  if (_dim >= 3 && !_w_var)
60  paramError("w",
61  "In three-dimensions, the w velocity must be supplied and it must be a "
62  "MooseLinearVariableFVReal.");
63 
64  _vel_vars.push_back(_w_var);
65 }
SubProblem::mesh
virtual MooseMesh & mesh()=0
LinearFVAdvectionDiffusionBC::paramError
void paramError(const std::string &param, Args... args) const
LinearFVVelocitySymmetryBC::_u_var
const MooseLinearVariableFVReal *const _u_var
Velocity in direction x.
Definition: LinearFVVelocitySymmetryBC.h:49
LinearFVAdvectionDiffusionBC::parameters
const InputParameters & parameters() const
LinearFVAdvectionDiffusionBC::LinearFVAdvectionDiffusionBC
LinearFVAdvectionDiffusionBC(const InputParameters &parameters)
FEProblemBase::getVariable
virtual const MooseVariableFieldBase & getVariable(const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY) const override
MooseMesh::dimension
virtual unsigned int dimension() const
LinearFVVelocitySymmetryBC::_vel_vars
std::vector< const MooseLinearVariableFVReal * > _vel_vars
For convenience we organize the velocity variables in a vector.
Definition: LinearFVVelocitySymmetryBC.h:56
LinearFVVelocitySymmetryBC::_dim
const unsigned int _dim
The dimension of the mesh.
Definition: LinearFVVelocitySymmetryBC.h:46
LinearFVVelocitySymmetryBC::_v_var
const MooseLinearVariableFVReal *const _v_var
Velocity in direction y.
Definition: LinearFVVelocitySymmetryBC.h:51
LinearFVVelocitySymmetryBC::_w_var
const MooseLinearVariableFVReal *const _w_var
Velocity in direction z.
Definition: LinearFVVelocitySymmetryBC.h:53
LinearFVVelocitySymmetryBC::_index
const unsigned int _index
Index x|y|z, this is mainly to handle the deviatoric parts correctly in in the stress term...
Definition: LinearFVVelocitySymmetryBC.h:60
InputParameters::isParamValid
bool isParamValid(const std::string &name) const

Member Function Documentation

◆ computeBoundaryGradientMatrixContribution()

Real LinearFVVelocitySymmetryBC::computeBoundaryGradientMatrixContribution ( ) const
overridevirtual

Implements LinearFVAdvectionDiffusionBC.

Definition at line 142 of file LinearFVVelocitySymmetryBC.C.

143 {
144  // We don't have to flip the sign of the normal because we are subtacting normal*normal.
145  const auto normal_component = _current_face_info->normal()(_index);
146  const auto normal_component_sq = normal_component * normal_component;
147 
148  return normal_component_sq / computeCellToFaceDistance();
149 }
LinearFVAdvectionDiffusionBC::computeCellToFaceDistance
Real computeCellToFaceDistance() const
FaceInfo::normal
const Point & normal() const
LinearFVAdvectionDiffusionBC::_current_face_info
const FaceInfo * _current_face_info
LinearFVVelocitySymmetryBC::_index
const unsigned int _index
Index x|y|z, this is mainly to handle the deviatoric parts correctly in in the stress term...
Definition: LinearFVVelocitySymmetryBC.h:60

◆ computeBoundaryGradientRHSContribution()

Real LinearFVVelocitySymmetryBC::computeBoundaryGradientRHSContribution ( ) const
overridevirtual

Implements LinearFVAdvectionDiffusionBC.

Definition at line 152 of file LinearFVVelocitySymmetryBC.C.

153 {
154  // We allow internal boundaries too so we need to check which side we are on
155  const auto elem_info = _current_face_type == FaceInfo::VarFaceNeighbors::ELEM
156  ? _current_face_info->elemInfo()
157  : _current_face_info->neighborInfo();
158 
159  auto boundary_value = _var.getElemValue(*elem_info, determineState());
160 
161  // We don't have to flip the sign of the normal because we are subtacting normal*normal.
162  const auto normal_component = _current_face_info->normal()(_index);
163  const auto normal_component_sq = normal_component * normal_component;
164  return computeBoundaryNormalGradient() -
165  normal_component_sq / computeCellToFaceDistance() * boundary_value;
166 }
LinearFVAdvectionDiffusionBC::computeCellToFaceDistance
Real computeCellToFaceDistance() const
LinearFVAdvectionDiffusionBC::determineState
Moose::StateArg determineState() const
FaceInfo::neighborInfo
const ElemInfo * neighborInfo() const
FaceInfo::elemInfo
const ElemInfo * elemInfo() const
LinearFVAdvectionDiffusionBC::_current_face_type
FaceInfo::VarFaceNeighbors _current_face_type
FaceInfo::normal
const Point & normal() const
LinearFVAdvectionDiffusionBC::_var
MooseLinearVariableFV< Real > & _var
LinearFVAdvectionDiffusionBC::_current_face_info
const FaceInfo * _current_face_info
MooseLinearVariableFV< Real >::getElemValue
Real getElemValue(const ElemInfo &elem_info, const StateArg &state) const
LinearFVVelocitySymmetryBC::computeBoundaryNormalGradient
virtual Real computeBoundaryNormalGradient() const override
Definition: LinearFVVelocitySymmetryBC.C:91
LinearFVVelocitySymmetryBC::_index
const unsigned int _index
Index x|y|z, this is mainly to handle the deviatoric parts correctly in in the stress term...
Definition: LinearFVVelocitySymmetryBC.h:60

◆ computeBoundaryNormalGradient()

Real LinearFVVelocitySymmetryBC::computeBoundaryNormalGradient ( ) const
overridevirtual

Implements LinearFVAdvectionDiffusionBC.

Definition at line 91 of file LinearFVVelocitySymmetryBC.C.

Referenced by computeBoundaryGradientRHSContribution().

92 {
93  // We allow internal boundaries too so we need to check which side we are on
94  const auto elem_info = _current_face_type == FaceInfo::VarFaceNeighbors::ELEM
95  ? _current_face_info->elemInfo()
96  : _current_face_info->neighborInfo();
97 
98  Real boundary_normal_grad = 0.0;
99 
100  // We don't have to flip the sign of the normal because we are subtacting normal*normal.
101  auto scaled_normal = _current_face_info->normal();
102  scaled_normal *= scaled_normal(_index);
103 
104  for (const auto dim_i : make_range(_dim))
105  boundary_normal_grad +=
106  scaled_normal(dim_i) * _vel_vars[dim_i]->getElemValue(*elem_info, determineState());
107 
108  return boundary_normal_grad / computeCellToFaceDistance();
109 }
LinearFVAdvectionDiffusionBC::computeCellToFaceDistance
Real computeCellToFaceDistance() const
LinearFVAdvectionDiffusionBC::determineState
Moose::StateArg determineState() const
FaceInfo::neighborInfo
const ElemInfo * neighborInfo() const
FaceInfo::elemInfo
const ElemInfo * elemInfo() const
LinearFVAdvectionDiffusionBC::_current_face_type
FaceInfo::VarFaceNeighbors _current_face_type
FaceInfo::normal
const Point & normal() const
LinearFVVelocitySymmetryBC::_vel_vars
std::vector< const MooseLinearVariableFVReal * > _vel_vars
For convenience we organize the velocity variables in a vector.
Definition: LinearFVVelocitySymmetryBC.h:56
LinearFVVelocitySymmetryBC::_dim
const unsigned int _dim
The dimension of the mesh.
Definition: LinearFVVelocitySymmetryBC.h:46
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
LinearFVAdvectionDiffusionBC::_current_face_info
const FaceInfo * _current_face_info
make_range
IntRange< T > make_range(T beg, T end)
LinearFVVelocitySymmetryBC::_index
const unsigned int _index
Index x|y|z, this is mainly to handle the deviatoric parts correctly in in the stress term...
Definition: LinearFVVelocitySymmetryBC.h:60

◆ computeBoundaryValue()

Real LinearFVVelocitySymmetryBC::computeBoundaryValue ( ) const
overridevirtual

Overriding all of these.

Implements LinearFVAdvectionDiffusionBC.

Definition at line 68 of file LinearFVVelocitySymmetryBC.C.

Referenced by computeBoundaryValueRHSContribution().

69 {
70  // We allow internal boundaries too so we need to check which side we are on
71  const auto elem_info = _current_face_type == FaceInfo::VarFaceNeighbors::ELEM
72  ? _current_face_info->elemInfo()
73  : _current_face_info->neighborInfo();
74 
75  // By default we approximate the boundary value with the neighboring cell value
76  auto boundary_value = _var.getElemValue(*elem_info, determineState());
77  auto reflected_boundary_value = boundary_value;
78 
79  // We don't have to flip the sign of the normal because we are subtacting normal*normal.
80  auto scaled_normal = _current_face_info->normal();
81  scaled_normal *= 2 * scaled_normal(_index);
82 
83  for (const auto dim_i : make_range(_dim))
84  reflected_boundary_value -=
85  scaled_normal(dim_i) * _vel_vars[dim_i]->getElemValue(*elem_info, determineState());
86 
87  return 0.5 * (boundary_value + reflected_boundary_value);
88 }
LinearFVAdvectionDiffusionBC::determineState
Moose::StateArg determineState() const
FaceInfo::neighborInfo
const ElemInfo * neighborInfo() const
FaceInfo::elemInfo
const ElemInfo * elemInfo() const
LinearFVAdvectionDiffusionBC::_current_face_type
FaceInfo::VarFaceNeighbors _current_face_type
FaceInfo::normal
const Point & normal() const
LinearFVVelocitySymmetryBC::_vel_vars
std::vector< const MooseLinearVariableFVReal * > _vel_vars
For convenience we organize the velocity variables in a vector.
Definition: LinearFVVelocitySymmetryBC.h:56
LinearFVAdvectionDiffusionBC::_var
MooseLinearVariableFV< Real > & _var
LinearFVVelocitySymmetryBC::_dim
const unsigned int _dim
The dimension of the mesh.
Definition: LinearFVVelocitySymmetryBC.h:46
LinearFVAdvectionDiffusionBC::_current_face_info
const FaceInfo * _current_face_info
MooseLinearVariableFV< Real >::getElemValue
Real getElemValue(const ElemInfo &elem_info, const StateArg &state) const
make_range
IntRange< T > make_range(T beg, T end)
LinearFVVelocitySymmetryBC::_index
const unsigned int _index
Index x|y|z, this is mainly to handle the deviatoric parts correctly in in the stress term...
Definition: LinearFVVelocitySymmetryBC.h:60

◆ computeBoundaryValueMatrixContribution()

Real LinearFVVelocitySymmetryBC::computeBoundaryValueMatrixContribution ( ) const
overridevirtual

Implements LinearFVAdvectionDiffusionBC.

Definition at line 112 of file LinearFVVelocitySymmetryBC.C.

113 {
114  // No matter if we have a one-term or two-term expansion we will always
115  // have a contribution to the matrix
116  const auto normal_component = _current_face_info->normal()(_index);
117  const auto normal_component_sq = normal_component * normal_component;
118  return 1.0 - normal_component_sq;
119 }
FaceInfo::normal
const Point & normal() const
LinearFVAdvectionDiffusionBC::_current_face_info
const FaceInfo * _current_face_info
LinearFVVelocitySymmetryBC::_index
const unsigned int _index
Index x|y|z, this is mainly to handle the deviatoric parts correctly in in the stress term...
Definition: LinearFVVelocitySymmetryBC.h:60

◆ computeBoundaryValueRHSContribution()

Real LinearFVVelocitySymmetryBC::computeBoundaryValueRHSContribution ( ) const
overridevirtual

Implements LinearFVAdvectionDiffusionBC.

Definition at line 122 of file LinearFVVelocitySymmetryBC.C.

123 {
124  // We allow internal boundaries too so we need to check which side we are on
125  const auto elem_info = _current_face_type == FaceInfo::VarFaceNeighbors::ELEM
126  ? _current_face_info->elemInfo()
127  : _current_face_info->neighborInfo();
128 
129  // We don't have to flip the sign of the normal because we are subtacting normal*normal.
130  auto scaled_normal = _current_face_info->normal();
131  scaled_normal *= scaled_normal(_index);
132 
133  auto current_bd_value = computeBoundaryValue();
134  const auto normal_component = _current_face_info->normal()(_index);
135  const auto normal_component_sq = normal_component * normal_component;
136 
137  return current_bd_value -
138  (1.0 - normal_component_sq) * _var.getElemValue(*elem_info, determineState());
139 }
LinearFVVelocitySymmetryBC::computeBoundaryValue
virtual Real computeBoundaryValue() const override
Overriding all of these.
Definition: LinearFVVelocitySymmetryBC.C:68
LinearFVAdvectionDiffusionBC::determineState
Moose::StateArg determineState() const
FaceInfo::neighborInfo
const ElemInfo * neighborInfo() const
FaceInfo::elemInfo
const ElemInfo * elemInfo() const
LinearFVAdvectionDiffusionBC::_current_face_type
FaceInfo::VarFaceNeighbors _current_face_type
FaceInfo::normal
const Point & normal() const
LinearFVAdvectionDiffusionBC::_var
MooseLinearVariableFV< Real > & _var
LinearFVAdvectionDiffusionBC::_current_face_info
const FaceInfo * _current_face_info
MooseLinearVariableFV< Real >::getElemValue
Real getElemValue(const ElemInfo &elem_info, const StateArg &state) const
LinearFVVelocitySymmetryBC::_index
const unsigned int _index
Index x|y|z, this is mainly to handle the deviatoric parts correctly in in the stress term...
Definition: LinearFVVelocitySymmetryBC.h:60

◆ validParams()

InputParameters LinearFVVelocitySymmetryBC::validParams ( )
static

Definition at line 16 of file LinearFVVelocitySymmetryBC.C.

17 {
18  InputParameters params = LinearFVAdvectionDiffusionBC::validParams();
19  params.addClassDescription("Adds a symmetry boundary condition for the velocity.");
20  params.addRequiredParam<SolverVariableName>("u", "The velocity in the x direction.");
21  params.addParam<SolverVariableName>("v", "The velocity in the y direction.");
22  params.addParam<SolverVariableName>("w", "The velocity in the z direction.");
23  MooseEnum momentum_component("x=0 y=1 z=2");
24  params.addRequiredParam<MooseEnum>(
25  "momentum_component",
26  momentum_component,
27  "The component of the momentum equation that this kernel applies to.");
28 
29  return params;
30 }
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)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
LinearFVAdvectionDiffusionBC::validParams
static InputParameters validParams()

Member Data Documentation

◆ _dim

const unsigned int LinearFVVelocitySymmetryBC::_dim
protected

The dimension of the mesh.

Definition at line 46 of file LinearFVVelocitySymmetryBC.h.

Referenced by computeBoundaryNormalGradient(), computeBoundaryValue(), and LinearFVVelocitySymmetryBC().

◆ _index

const unsigned int LinearFVVelocitySymmetryBC::_index
protected

Index x|y|z, this is mainly to handle the deviatoric parts correctly in in the stress term.

Definition at line 60 of file LinearFVVelocitySymmetryBC.h.

Referenced by computeBoundaryGradientMatrixContribution(), computeBoundaryGradientRHSContribution(), computeBoundaryNormalGradient(), computeBoundaryValue(), computeBoundaryValueMatrixContribution(), and computeBoundaryValueRHSContribution().

◆ _u_var

const MooseLinearVariableFVReal* const LinearFVVelocitySymmetryBC::_u_var
protected

Velocity in direction x.

Definition at line 49 of file LinearFVVelocitySymmetryBC.h.

Referenced by LinearFVVelocitySymmetryBC().

◆ _v_var

const MooseLinearVariableFVReal* const LinearFVVelocitySymmetryBC::_v_var
protected

Velocity in direction y.

Definition at line 51 of file LinearFVVelocitySymmetryBC.h.

Referenced by LinearFVVelocitySymmetryBC().

◆ _vel_vars

std::vector<const MooseLinearVariableFVReal *> LinearFVVelocitySymmetryBC::_vel_vars
protected

For convenience we organize the velocity variables in a vector.

Definition at line 56 of file LinearFVVelocitySymmetryBC.h.

Referenced by computeBoundaryNormalGradient(), computeBoundaryValue(), and LinearFVVelocitySymmetryBC().

◆ _w_var

const MooseLinearVariableFVReal* const LinearFVVelocitySymmetryBC::_w_var
protected

Velocity in direction z.

Definition at line 53 of file LinearFVVelocitySymmetryBC.h.

Referenced by LinearFVVelocitySymmetryBC().

The documentation for this class was generated from the following files:
Generated on Wed Jun 24 2026 08:32:37 for https://mooseframework.inl.gov by   doxygen 1.8.14