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

Abstract base class for computing and caching internal or boundary fluxes for RDG for the 3-equation model of 1-phase flow. More...

#include <NumericalFlux3EqnBase.h>

Inheritance diagram for NumericalFlux3EqnBase:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 NumericalFlux3EqnBase (const InputParameters &parameters)
 
virtual void execute () override
 
virtual void initialize () override
 
virtual void finalize () override
 
virtual void threadJoin (const UserObject &) override
 
virtual const std::vector< Real > & getFlux (const unsigned int iside, const dof_id_type ielem, bool res_side_is_left, const std::vector< Real > &UL, const std::vector< Real > &UR, const Real &nLR_dot_d) const
 Gets the flux vector for an element/side combination. More...
 
virtual const DenseMatrix< Real > & getJacobian (bool res_side_is_left, bool jac_side_is_left, const unsigned int iside, const dof_id_type ielem, const std::vector< Real > &UL, const std::vector< Real > &UR, const Real &nLR_dot_d) const
 Gets the flux Jacobian matrix for an element/side combination. More...
 
virtual void calcFlux (const std::vector< Real > &UL, const std::vector< Real > &UR, const Real &nLR_dot_d, std::vector< Real > &FL, std::vector< Real > &FR) const =0
 Calculates the flux vectors given "left" and "right" states. More...
 
virtual void calcJacobian (const std::vector< Real > &UL, const std::vector< Real > &UR, const Real &nLR_dot_d, DenseMatrix< Real > &dFL_dUL, DenseMatrix< Real > &dFL_dUR, DenseMatrix< Real > &dFR_dUL, DenseMatrix< Real > &dFR_dUR) const =0
 Calculates the flux Jacobian matrices given "left" and "right" states. More...
 
unsigned int getLastRegionIndex () const
 Returns the index of the region last entered. More...
 
virtual unsigned int getNumberOfRegions () const =0
 Returns the total possible number of regions. More...
 
virtual void subdomainSetup () override
 
bool needThreadedCopy () const override final
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () const
 
void gatherSum (T &value)
 
void gatherMax (T &value)
 
void gatherMin (T &value)
 
void gatherProxyValueMax (T1 &proxy, T2 &value)
 
void gatherProxyValueMin (T1 &proxy, T2 &value)
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
std::set< UserObjectName > getDependObjects () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () const
 
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 timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () 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
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
bool isImplicit ()
 
Moose::StateArg determineState () 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 GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
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
 
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
 
T & getSampler (const std::string &name)
 
Sampler & getSampler (const std::string &name)
 
T & getSamplerByName (const SamplerName &name)
 
Sampler & getSamplerByName (const SamplerName &name)
 
virtual void meshChanged ()
 
virtual void meshDisplaced ()
 
PerfGraph & perfGraph ()
 
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 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
 
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 sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObject &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
const ReporterName & getReporterName (const std::string &param_name) 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
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_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 void checkMaterialProperty (const std::string &name, const unsigned int state)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

unsigned int _cached_flux_elem_id
 element ID of the cached flux values More...
 
unsigned int _cached_flux_side_id
 side ID of the cached flux values More...
 
unsigned int _cached_jacobian_elem_id
 element ID of the cached Jacobian values More...
 
unsigned int _cached_jacobian_side_id
 side ID of the cached Jacobian values More...
 
std::vector< Real > _FL
 flux vector for the "left" cell More...
 
std::vector< Real > _FR
 flux vector for the "right" cell More...
 
DenseMatrix< Real > _dFL_dUL
 derivative of "left" flux w.r.t. "left" solution More...
 
DenseMatrix< Real > _dFL_dUR
 derivative of "left" flux w.r.t. "right" solution More...
 
DenseMatrix< Real > _dFR_dUL
 derivative of "right" flux w.r.t. "left" solution More...
 
DenseMatrix< Real > _dFR_dUR
 derivative of "right" flux w.r.t. "right" solution More...
 
unsigned int _last_region_index
 Index describing the region last entered, which is useful for testing and debugging. More...
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
const THREAD_ID _tid
 
Assembly & _assembly
 
const Moose::CoordinateSystemType & _coord_sys
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
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
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
FEProblemBase & _mdi_feproblem
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const InputParameters & _mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase & _mi_feproblem
 
SubProblem & _mi_subproblem
 
const THREAD_ID _mi_tid
 
const Moose::MaterialDataType _material_data_type
 
MaterialData & _material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int > _material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
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
 
const Parallel::Communicator & _communicator
 

Static Protected Attributes

static const std::string _interpolated_old
 
static const std::string _interpolated_older
 

Detailed Description

Abstract base class for computing and caching internal or boundary fluxes for RDG for the 3-equation model of 1-phase flow.

This base class adds interfaces useful for testing purposes; specifically, since some fluxes have different regions, depending on flow conditions, it is important to ensure that all are tested. To help with this, an interface is added to retrieve the last entered region.

Definition at line 23 of file NumericalFlux3EqnBase.h.

Constructor & Destructor Documentation

◆ NumericalFlux3EqnBase()

NumericalFlux3EqnBase::NumericalFlux3EqnBase ( const InputParameters &  parameters)

Definition at line 21 of file NumericalFlux3EqnBase.C.

22  : ThreadedGeneralUserObject(parameters),
23 
24  _cached_flux_elem_id(libMesh::invalid_uint),
25  _cached_flux_side_id(libMesh::invalid_uint),
26  _cached_jacobian_elem_id(libMesh::invalid_uint),
27  _cached_jacobian_side_id(libMesh::invalid_uint),
28 
29  _last_region_index(0)
30 {
31 }
libMesh::invalid_uint
const unsigned int invalid_uint
NumericalFlux3EqnBase::_cached_jacobian_elem_id
unsigned int _cached_jacobian_elem_id
element ID of the cached Jacobian values
Definition: NumericalFlux3EqnBase.h:152
ThreadedGeneralUserObject::ThreadedGeneralUserObject
ThreadedGeneralUserObject(const InputParameters &parameters)
NumericalFlux3EqnBase::_cached_jacobian_side_id
unsigned int _cached_jacobian_side_id
side ID of the cached Jacobian values
Definition: NumericalFlux3EqnBase.h:154
NumericalFlux3EqnBase::_cached_flux_elem_id
unsigned int _cached_flux_elem_id
element ID of the cached flux values
Definition: NumericalFlux3EqnBase.h:147
NumericalFlux3EqnBase::_last_region_index
unsigned int _last_region_index
Index describing the region last entered, which is useful for testing and debugging.
Definition: NumericalFlux3EqnBase.h:170
ThreadedGeneralUserObject::parameters
const InputParameters & parameters() const
NumericalFlux3EqnBase::_cached_flux_side_id
unsigned int _cached_flux_side_id
side ID of the cached flux values
Definition: NumericalFlux3EqnBase.h:149

Member Function Documentation

◆ calcFlux()

virtual void NumericalFlux3EqnBase::calcFlux ( const std::vector< Real > &  UL,
const std::vector< Real > &  UR,
const Real &  nLR_dot_d,
std::vector< Real > &  FL,
std::vector< Real > &  FR 
) const
pure virtual

Calculates the flux vectors given "left" and "right" states.

This function is called only if the values are not already cached.

Parameters
[in]ULvector of variables on the "left"
[in]URvector of variables on the "right"
[in]nLR_dot_dDot product of direction from "left" to "right" with the flow channel direction
[out]FLflux vector to be added to "left" side
[out]FRflux vector to be added to "right" side

Referenced by getFlux().

◆ calcJacobian()

virtual void NumericalFlux3EqnBase::calcJacobian ( const std::vector< Real > &  UL,
const std::vector< Real > &  UR,
const Real &  nLR_dot_d,
DenseMatrix< Real > &  dFL_dUL,
DenseMatrix< Real > &  dFL_dUR,
DenseMatrix< Real > &  dFR_dUL,
DenseMatrix< Real > &  dFR_dUR 
) const
pure virtual

Calculates the flux Jacobian matrices given "left" and "right" states.

This function is called only if the values are not already cached.

Parameters
[in]ULvector of variables on the "left"
[in]URvector of variables on the "right"
[in]nLR_dot_dDot product of direction from "left" to "right" with the flow channel direction
[out]dFL_dULJacobian matrix of "left" flux w.r.t. "left" solution.
[out]dFL_dURJacobian matrix of "left" flux w.r.t. "right" solution.
[out]dFR_dULJacobian matrix of "right" flux w.r.t. "left" solution.
[out]dFR_dURJacobian matrix of "right" flux w.r.t. "right" solution.

Referenced by getJacobian().

◆ execute()

void NumericalFlux3EqnBase::execute ( )
overridevirtual

Implements ThreadedGeneralUserObject.

Definition at line 43 of file NumericalFlux3EqnBase.C.

44 {
45 }

◆ finalize()

void NumericalFlux3EqnBase::finalize ( )
overridevirtual

Implements ThreadedGeneralUserObject.

Definition at line 48 of file NumericalFlux3EqnBase.C.

49 {
50 }

◆ getFlux()

const std::vector< Real > & NumericalFlux3EqnBase::getFlux ( const unsigned int  iside,
const dof_id_type  ielem,
bool  res_side_is_left,
const std::vector< Real > &  UL,
const std::vector< Real > &  UR,
const Real &  nLR_dot_d 
) const
virtual

Gets the flux vector for an element/side combination.

If the element/side is cached, the cached values are used. Otherwise the values are computed, cached, and returned.

Parameters
[in]isidelocal index of current side
[in]ielemglobal index of the current element
[in]res_side_is_leftgetting flux on the left ("elem") side?
[in]ULvector of variables on the "left"
[in]URvector of variables on the "right"
[in]nLR_dot_dDot product of direction from "left" to "right" with the flow channel direction
Returns
flux vector for an element/side combination

Definition at line 58 of file NumericalFlux3EqnBase.C.

Referenced by NumericalFlux3EqnDGKernel::computeQpResidual().

64 {
65  if (_cached_flux_elem_id != ielem || _cached_flux_side_id != iside)
66  {
67  _cached_flux_elem_id = ielem;
68  _cached_flux_side_id = iside;
69 
70  calcFlux(UL, UR, nLR_dot_d, _FL, _FR);
71  }
72 
73  if (res_side_is_left)
74  return _FL;
75  else
76  return _FR;
77 }
NumericalFlux3EqnBase::_FR
std::vector< Real > _FR
flux vector for the "right" cell
Definition: NumericalFlux3EqnBase.h:159
NumericalFlux3EqnBase::calcFlux
virtual void calcFlux(const std::vector< Real > &UL, const std::vector< Real > &UR, const Real &nLR_dot_d, std::vector< Real > &FL, std::vector< Real > &FR) const =0
Calculates the flux vectors given "left" and "right" states.
NumericalFlux3EqnBase::_cached_flux_elem_id
unsigned int _cached_flux_elem_id
element ID of the cached flux values
Definition: NumericalFlux3EqnBase.h:147
NumericalFlux3EqnBase::_FL
std::vector< Real > _FL
flux vector for the "left" cell
Definition: NumericalFlux3EqnBase.h:157
NumericalFlux3EqnBase::_cached_flux_side_id
unsigned int _cached_flux_side_id
side ID of the cached flux values
Definition: NumericalFlux3EqnBase.h:149

◆ getJacobian()

const DenseMatrix< Real > & NumericalFlux3EqnBase::getJacobian ( bool  res_side_is_left,
bool  jac_side_is_left,
const unsigned int  iside,
const dof_id_type  ielem,
const std::vector< Real > &  UL,
const std::vector< Real > &  UR,
const Real &  nLR_dot_d 
) const
virtual

Gets the flux Jacobian matrix for an element/side combination.

If the element/side is cached, the cached values are used. Otherwise the values are computed, cached, and returned. The user decides which Jacobian to receive (either with respect to "left" solution vector or "right" solution vector). If the user wants both, then the function can just be called a second time with the other Jacobian requested - since that Jacobian is already cached, no redundant calculations will occur.

Parameters
[in]res_side_is_leftgetting flux on the left ("elem") side?
[in]jac_side_is_lefttaking derivative w.r.t. the left ("elem") side?
[in]isidelocal index of current side
[in]ielemglobal index of the current element
[in]ULvector of variables on the "left"
[in]URvector of variables on the "right"
[in]nLR_dot_dDot product of direction from "left" to "right" with the flow channel direction
Returns
flux Jacobian matrix for an element/side combination

Definition at line 80 of file NumericalFlux3EqnBase.C.

Referenced by NumericalFlux3EqnDGKernel::computeQpOffDiagJacobian().

87 {
88  if (_cached_jacobian_elem_id != ielem || _cached_jacobian_side_id != iside)
89  {
90  _cached_jacobian_elem_id = ielem;
91  _cached_jacobian_side_id = iside;
92 
93  calcJacobian(UL, UR, nLR_dot_d, _dFL_dUL, _dFL_dUR, _dFR_dUL, _dFR_dUR);
94  }
95 
96  if (res_side_is_left)
97  {
98  if (jac_side_is_left)
99  return _dFL_dUL;
100  else
101  return _dFL_dUR;
102  }
103  else
104  {
105  if (jac_side_is_left)
106  return _dFR_dUL;
107  else
108  return _dFR_dUR;
109  }
110 }
NumericalFlux3EqnBase::_cached_jacobian_elem_id
unsigned int _cached_jacobian_elem_id
element ID of the cached Jacobian values
Definition: NumericalFlux3EqnBase.h:152
NumericalFlux3EqnBase::_dFR_dUR
DenseMatrix< Real > _dFR_dUR
derivative of "right" flux w.r.t. "right" solution
Definition: NumericalFlux3EqnBase.h:167
NumericalFlux3EqnBase::_dFL_dUL
DenseMatrix< Real > _dFL_dUL
derivative of "left" flux w.r.t. "left" solution
Definition: NumericalFlux3EqnBase.h:161
NumericalFlux3EqnBase::_cached_jacobian_side_id
unsigned int _cached_jacobian_side_id
side ID of the cached Jacobian values
Definition: NumericalFlux3EqnBase.h:154
NumericalFlux3EqnBase::calcJacobian
virtual void calcJacobian(const std::vector< Real > &UL, const std::vector< Real > &UR, const Real &nLR_dot_d, DenseMatrix< Real > &dFL_dUL, DenseMatrix< Real > &dFL_dUR, DenseMatrix< Real > &dFR_dUL, DenseMatrix< Real > &dFR_dUR) const =0
Calculates the flux Jacobian matrices given "left" and "right" states.
NumericalFlux3EqnBase::_dFL_dUR
DenseMatrix< Real > _dFL_dUR
derivative of "left" flux w.r.t. "right" solution
Definition: NumericalFlux3EqnBase.h:163
NumericalFlux3EqnBase::_dFR_dUL
DenseMatrix< Real > _dFR_dUL
derivative of "right" flux w.r.t. "left" solution
Definition: NumericalFlux3EqnBase.h:165

◆ getLastRegionIndex()

unsigned int NumericalFlux3EqnBase::getLastRegionIndex ( ) const
inline

Returns the index of the region last entered.

Here "region" refers to a code path taken. For some fluxes, such as centered fluxes, there is just a single code path, but for others, such as those using an approximate Riemann solver, there are multiple. Riemann solvers have "regions" defined by the characteristic waves.

Definition at line 133 of file NumericalFlux3EqnBase.h.

133 { return _last_region_index; }
NumericalFlux3EqnBase::_last_region_index
unsigned int _last_region_index
Index describing the region last entered, which is useful for testing and debugging.
Definition: NumericalFlux3EqnBase.h:170

◆ getNumberOfRegions()

virtual unsigned int NumericalFlux3EqnBase::getNumberOfRegions ( ) const
pure virtual

Returns the total possible number of regions.

Here "region" refers to a code path taken. For some fluxes, such as centered fluxes, there is just a single code path, but for others, such as those using an approximate Riemann solver, there are multiple. Riemann solvers have "regions" defined by the characteristic waves.

◆ initialize()

void NumericalFlux3EqnBase::initialize ( )
overridevirtual

Implements ThreadedGeneralUserObject.

Definition at line 34 of file NumericalFlux3EqnBase.C.

35 {
36  _cached_flux_elem_id = libMesh::invalid_uint;
37  _cached_flux_side_id = libMesh::invalid_uint;
38  _cached_jacobian_elem_id = libMesh::invalid_uint;
39  _cached_jacobian_side_id = libMesh::invalid_uint;
40 }
libMesh::invalid_uint
const unsigned int invalid_uint
NumericalFlux3EqnBase::_cached_jacobian_elem_id
unsigned int _cached_jacobian_elem_id
element ID of the cached Jacobian values
Definition: NumericalFlux3EqnBase.h:152
NumericalFlux3EqnBase::_cached_jacobian_side_id
unsigned int _cached_jacobian_side_id
side ID of the cached Jacobian values
Definition: NumericalFlux3EqnBase.h:154
NumericalFlux3EqnBase::_cached_flux_elem_id
unsigned int _cached_flux_elem_id
element ID of the cached flux values
Definition: NumericalFlux3EqnBase.h:147
NumericalFlux3EqnBase::_cached_flux_side_id
unsigned int _cached_flux_side_id
side ID of the cached flux values
Definition: NumericalFlux3EqnBase.h:149

◆ threadJoin()

void NumericalFlux3EqnBase::threadJoin ( const UserObject &  )
overridevirtual

Reimplemented from ThreadedGeneralUserObject.

Definition at line 53 of file NumericalFlux3EqnBase.C.

54 {
55 }

◆ validParams()

InputParameters NumericalFlux3EqnBase::validParams ( )
static

Definition at line 13 of file NumericalFlux3EqnBase.C.

14 {
15  InputParameters params = GeneralUserObject::validParams();
16  params.addClassDescription(
17  "Base class for implemented objects that compute the numerical flux of the 3-equation model");
18  return params;
19 }
GeneralUserObject::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _cached_flux_elem_id

unsigned int NumericalFlux3EqnBase::_cached_flux_elem_id
mutableprotected

element ID of the cached flux values

Definition at line 147 of file NumericalFlux3EqnBase.h.

Referenced by getFlux(), and initialize().

◆ _cached_flux_side_id

unsigned int NumericalFlux3EqnBase::_cached_flux_side_id
mutableprotected

side ID of the cached flux values

Definition at line 149 of file NumericalFlux3EqnBase.h.

Referenced by getFlux(), and initialize().

◆ _cached_jacobian_elem_id

unsigned int NumericalFlux3EqnBase::_cached_jacobian_elem_id
mutableprotected

element ID of the cached Jacobian values

Definition at line 152 of file NumericalFlux3EqnBase.h.

Referenced by getJacobian(), and initialize().

◆ _cached_jacobian_side_id

unsigned int NumericalFlux3EqnBase::_cached_jacobian_side_id
mutableprotected

side ID of the cached Jacobian values

Definition at line 154 of file NumericalFlux3EqnBase.h.

Referenced by getJacobian(), and initialize().

◆ _dFL_dUL

DenseMatrix<Real> NumericalFlux3EqnBase::_dFL_dUL
mutableprotected

derivative of "left" flux w.r.t. "left" solution

Definition at line 161 of file NumericalFlux3EqnBase.h.

Referenced by getJacobian().

◆ _dFL_dUR

DenseMatrix<Real> NumericalFlux3EqnBase::_dFL_dUR
mutableprotected

derivative of "left" flux w.r.t. "right" solution

Definition at line 163 of file NumericalFlux3EqnBase.h.

Referenced by getJacobian().

◆ _dFR_dUL

DenseMatrix<Real> NumericalFlux3EqnBase::_dFR_dUL
mutableprotected

derivative of "right" flux w.r.t. "left" solution

Definition at line 165 of file NumericalFlux3EqnBase.h.

Referenced by getJacobian().

◆ _dFR_dUR

DenseMatrix<Real> NumericalFlux3EqnBase::_dFR_dUR
mutableprotected

derivative of "right" flux w.r.t. "right" solution

Definition at line 167 of file NumericalFlux3EqnBase.h.

Referenced by getJacobian().

◆ _FL

std::vector<Real> NumericalFlux3EqnBase::_FL
mutableprotected

flux vector for the "left" cell

Definition at line 157 of file NumericalFlux3EqnBase.h.

Referenced by getFlux().

◆ _FR

std::vector<Real> NumericalFlux3EqnBase::_FR
mutableprotected

flux vector for the "right" cell

Definition at line 159 of file NumericalFlux3EqnBase.h.

Referenced by getFlux().

◆ _last_region_index

unsigned int NumericalFlux3EqnBase::_last_region_index
mutableprotected

Index describing the region last entered, which is useful for testing and debugging.

Definition at line 170 of file NumericalFlux3EqnBase.h.

Referenced by getLastRegionIndex().

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