standard SUPG relationships valid for the Richards equation. More...

#include <RichardsSUPGstandard.h>

Inheritance diagram for RichardsSUPGstandard:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	RichardsSUPGstandard (const InputParameters &parameters)

RealVectorValue	velSUPG (RealTensorValue perm, RealVectorValue gradp, Real density, RealVectorValue gravity) const
	SUPG velocity = -perm(gradp - densitygravity) This points in direction of information propagation. More...

RealTensorValue	dvelSUPG_dgradp (RealTensorValue perm) const
	derivative of SUPG velocity wrt gradient of porepressure More...

RealVectorValue	dvelSUPG_dp (RealTensorValue perm, Real density_prime, RealVectorValue gravity) const
	derivative of SUPG velocity wrt porepressure (keeping gradp fixed) More...

RealVectorValue	bb (RealVectorValue vel, int dimen, RealVectorValue xi_prime, RealVectorValue eta_prime, RealVectorValue zeta_prime) const
	\|bb\| ~ 2*velocity/element_length More...

RealVectorValue	dbb2_dgradp (RealVectorValue vel, RealTensorValue dvel_dgradp, RealVectorValue xi_prime, RealVectorValue eta_prime, RealVectorValue zeta_prime) const
	derivative of bb*bb wrt gradient of porepressure More...

Real	dbb2_dp (RealVectorValue vel, RealVectorValue dvel_dp, RealVectorValue xi_prime, RealVectorValue eta_prime, RealVectorValue zeta_prime) const
	derivative of bb*bb wrt porepressure More...

Real	tauSUPG (RealVectorValue vel, Real traceperm, RealVectorValue b) const
	The SUPG tau parameter. More...

RealVectorValue	dtauSUPG_dgradp (RealVectorValue vel, RealTensorValue dvel_dgradp, Real traceperm, RealVectorValue b, RealVectorValue db2_dgradp) const
	derivative of tau wrt gradient of porepressure More...

Real	dtauSUPG_dp (RealVectorValue vel, RealVectorValue dvel_dp, Real traceperm, RealVectorValue b, Real db2_dp) const
	derivative of tau wrt porepressure (keeping gradp fixed) More...

bool	SUPG_trivial () const
	returns false in this case since everything is trivial More...

void	initialize ()

void	execute ()

void	finalize ()

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 &value, T2 &proxy)

void	gatherProxyValueMin (T1 &value, T2 &proxy)

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

std::set< UserObjectName >	getDependObjects () const

virtual bool	needThreadedCopy () 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 &	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 &name, const std::string *param=nullptr) 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 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

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

virtual void	threadJoin (const UserObject &) override

virtual void	threadJoin (const UserObject &) override

virtual void	subdomainSetup () override

virtual void	subdomainSetup () override

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

const std::vector< MooseVariableScalar *> &	getCoupledMooseScalarVars ()

const std::set< TagID > &	getScalarVariableCoupleableVectorTags () const

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () const

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

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

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

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

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

Moose::StateArg	determineState () const

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
Real	_p_SUPG
	the SUPG pressure parameter This dictates how strong the SUPG is _p_SUPG large means only a little SUPG _p_SUPG small means close to fully-upwind 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 &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

MooseApp &	_pg_moose_app

const std::string	_prefix

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

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

Private Member Functions
Real	cosh_relation (Real alpha) const
	cosh(alpha)/sinh(alpha) - 1/alpha, modified at extreme values of alpha to prevent overflows More...

Real	cosh_relation_prime (Real alpha) const
	derivative of cosh_relation wrt alpha More...

Detailed Description

standard SUPG relationships valid for the Richards equation.

here i use a formula for "tau" presented in Appendix A of TJR Hughes, M Mallet and A Mizukami `‘A new finite element formulation for computational fluid dynamics:: II. Behond SUPG’' Computer Methods in Applied Mechanics and Engineering 54 (1986) 341–355

Definition at line 22 of file RichardsSUPGstandard.h.

Constructor & Destructor Documentation

◆ RichardsSUPGstandard()

RichardsSUPGstandard::RichardsSUPGstandard ( const InputParameters & parameters )

Definition at line 36 of file RichardsSUPGstandard.C.

   : RichardsSUPG(parameters), _p_SUPG(getParam<Real>("p_SUPG"))
 {
 }

Member Function Documentation

◆ bb()

RealVectorValue RichardsSUPGstandard::bb	(	RealVectorValue	vel,
		int	dimen,
		RealVectorValue	xi_prime,
		RealVectorValue	eta_prime,
		RealVectorValue	zeta_prime
	)		const

virtual

|bb| ~ 2*velocity/element_length

Parameters

vel	SUPG velocity
dimen	dimension of problem
xi_prime	spatial gradient of the isoparametric coordinate xi
eta_prime	spatial gradient of the isoparametric coordinate eta
zeta_prime	spatial gradient of the isoparametric coordinate zeta

Implements RichardsSUPG.

Definition at line 86 of file RichardsSUPGstandard.C.

 {
   RealVectorValue b;
   b(0) = xi_prime * vel;
   if (dimen >= 2)
     b(1) = eta_prime * vel;
   if (dimen == 3)
     b(2) = zeta_prime * vel;
   return b;
 }

◆ cosh_relation()

Real RichardsSUPGstandard::cosh_relation ( Real alpha ) const

private

cosh(alpha)/sinh(alpha) - 1/alpha, modified at extreme values of alpha to prevent overflows

Definition at line 65 of file RichardsSUPGstandard.C.

Referenced by dtauSUPG_dgradp(), dtauSUPG_dp(), and tauSUPG().

 {
   if (alpha >= 5.0 || alpha <= -5.0)
     return ((alpha > 0.0) ? 1.0 : -1.0) - 1.0 / alpha; // prevents overflows
   else if (alpha == 0)
     return 0.0;
   return 1.0 / std::tanh(alpha) - 1.0 / alpha;
 }

◆ cosh_relation_prime()

Real RichardsSUPGstandard::cosh_relation_prime ( Real alpha ) const

private

derivative of cosh_relation wrt alpha

Definition at line 75 of file RichardsSUPGstandard.C.

Referenced by dtauSUPG_dgradp(), and dtauSUPG_dp().

 {
   if (alpha >= 5.0 || alpha <= -5.0)
     return 1.0 / (alpha * alpha); // prevents overflows
   else if (alpha == 0)
     return 1.0 / 3.0;
   return 1.0 - Utility::pow<2>(std::cosh(alpha) / std::sinh(alpha)) + 1.0 / (alpha * alpha);
 }

◆ dbb2_dgradp()

RealVectorValue RichardsSUPGstandard::dbb2_dgradp	(	RealVectorValue	vel,
		RealTensorValue	dvel_dgradp,
		RealVectorValue	xi_prime,
		RealVectorValue	eta_prime,
		RealVectorValue	zeta_prime
	)		const

virtual

derivative of bb*bb wrt gradient of porepressure

Parameters

vel	SUPG velocity
dvel_dgradp	derivative of velocity wrt gradient of porepressure
xi_prime	spatial gradient of the isoparametric coordinate xi
eta_prime	spatial gradient of the isoparametric coordinate eta
zeta_prime	spatial gradient of the isoparametric coordinate zeta

Implements RichardsSUPG.

Definition at line 103 of file RichardsSUPGstandard.C.

 {
   // if dvel_dgradp is symmetric so transpose is probably a waste of time
   return 2.0 * ((xi_prime * vel) * (dvel_dgradp.transpose() * xi_prime) +
                 (eta_prime * vel) * (dvel_dgradp.transpose() * eta_prime) +
                 (zeta_prime * vel) * (dvel_dgradp.transpose() * zeta_prime));
 }

◆ dbb2_dp()

Real RichardsSUPGstandard::dbb2_dp	(	RealVectorValue	vel,
		RealVectorValue	dvel_dp,
		RealVectorValue	xi_prime,
		RealVectorValue	eta_prime,
		RealVectorValue	zeta_prime
	)		const

virtual

derivative of bb*bb wrt porepressure

Parameters

vel	SUPG velocity
dvel_dp	derivative of velocity wrt porepressure
xi_prime	spatial gradient of the isoparametric coordinate xi
eta_prime	spatial gradient of the isoparametric coordinate eta
zeta_prime	spatial gradient of the isoparametric coordinate zeta

Implements RichardsSUPG.

Definition at line 117 of file RichardsSUPGstandard.C.

 {
   return 2.0 *
          ((xi_prime * vel) * (dvel_dp * xi_prime) + (eta_prime * vel) * (dvel_dp * eta_prime) +
           (zeta_prime * vel) * (dvel_dp * zeta_prime));
 }

◆ dtauSUPG_dgradp()

RealVectorValue RichardsSUPGstandard::dtauSUPG_dgradp	(	RealVectorValue	vel,
		RealTensorValue	dvel_dgradp,
		Real	traceperm,
		RealVectorValue	b,
		RealVectorValue	db2_dgradp
	)		const

virtual

derivative of tau wrt gradient of porepressure

Parameters

vel	SUPG velocity
dvel_dgradp	derivative of the SUPG velocity wrt gradient of porepressure
traceperm	trace of the permeability tensor for the material
b	the b parameter: \|b\| ~ 2*SUPGvelocity/element_length
db2_dgradp	derivative of b*b wrt gradient of porepressure

Implements RichardsSUPG.

Definition at line 149 of file RichardsSUPGstandard.C.

 {
   Real norm_vel = vel.norm();
   if (norm_vel == 0)
     return RealVectorValue();
 
   RealVectorValue norm_vel_dgradp(dvel_dgradp * vel / norm_vel);
 
   Real norm_b = b.norm();
   if (norm_b == 0)
     return RealVectorValue();
   RealVectorValue norm_b_dgradp = db2_dgradp / 2.0 / norm_b;
 
   Real h = 2 * norm_vel / norm_b; // h is a measure of the element length in the "a" direction
   RealVectorValue h_dgradp(2 * norm_vel_dgradp / norm_b -
                            2.0 * norm_vel * norm_b_dgradp / norm_b / norm_b);
 
   Real alpha = 0.5 * norm_vel * h / traceperm / _p_SUPG; // this is the Peclet number
   RealVectorValue alpha_dgradp =
       0.5 * (norm_vel_dgradp * h + norm_vel * h_dgradp) / traceperm / _p_SUPG;
 
   Real xi_tilde = RichardsSUPGstandard::cosh_relation(alpha);
   Real xi_tilde_prime = RichardsSUPGstandard::cosh_relation_prime(alpha);
   RealVectorValue xi_tilde_dgradp = xi_tilde_prime * alpha_dgradp;
 
   RealVectorValue tau_dgradp =
       xi_tilde_dgradp / norm_b - xi_tilde * norm_b_dgradp / (norm_b * norm_b);
 
   return tau_dgradp;
 }

◆ dtauSUPG_dp()

Real RichardsSUPGstandard::dtauSUPG_dp	(	RealVectorValue	vel,
		RealVectorValue	dvel_dp,
		Real	traceperm,
		RealVectorValue	b,
		Real	db2_dp
	)		const

virtual

derivative of tau wrt porepressure (keeping gradp fixed)

Parameters

vel	SUPG velocity
dvel_dp	derivative of the SUPG velocity wrt porepressure
traceperm	trace of the permeability tensor for the material
b	the b parameter: \|b\| ~ 2*SUPGvelocity/element_length
db2_dp	derivative of b*b wrt porepressure

Implements RichardsSUPG.

Definition at line 185 of file RichardsSUPGstandard.C.

 {
   Real norm_vel = vel.norm();
   if (norm_vel == 0.0)
     return 0.0; // this deriv is not necessarily correct, but i can't see a better thing to do
 
   Real norm_vel_dp = dvel_dp * vel / norm_vel;
 
   Real norm_b = b.norm();
   if (norm_b == 0)
     return 0.0; // this deriv is not necessarily correct, but i can't see a better thing to do
   Real norm_b_dp = db2_dp / (2.0 * norm_b);
 
   Real h = 2.0 * norm_vel / norm_b; // h is a measure of the element length in the "a" direction
   Real h_dp = 2.0 * norm_vel_dp / norm_b - 2.0 * norm_vel * norm_b_dp / (norm_b * norm_b);
 
   Real alpha = 0.5 * norm_vel * h / (traceperm * _p_SUPG); // this is the Peclet number
   Real alpha_dp = 0.5 * (norm_vel_dp * h + norm_vel * h_dp) / (traceperm * _p_SUPG);
 
   Real xi_tilde = RichardsSUPGstandard::cosh_relation(alpha);
   Real xi_tilde_prime = RichardsSUPGstandard::cosh_relation_prime(alpha);
   Real xi_tilde_dp = xi_tilde_prime * alpha_dp;
 
   // Real tau = xi_tilde/norm_b;
   const Real tau_dp = xi_tilde_dp / norm_b - xi_tilde * norm_b_dp / (norm_b * norm_b);
 
   return tau_dp;
 }

◆ dvelSUPG_dgradp()

RealTensorValue RichardsSUPGstandard::dvelSUPG_dgradp ( RealTensorValue perm ) const

virtual

derivative of SUPG velocity wrt gradient of porepressure

Parameters

perm	permeability tensor

Implements RichardsSUPG.

Definition at line 51 of file RichardsSUPGstandard.C.

 {
   return -perm;
 }

◆ dvelSUPG_dp()

RealVectorValue RichardsSUPGstandard::dvelSUPG_dp	(	RealTensorValue	perm,
		Real	density_prime,
		RealVectorValue	gravity
	)		const

virtual

derivative of SUPG velocity wrt porepressure (keeping gradp fixed)

Parameters

perm	permeability tensor
density_prime	derivative of fluid density wrt porepressure
gravity	gravitational acceleration vector

Implements RichardsSUPG.

Definition at line 57 of file RichardsSUPGstandard.C.

 {
   return perm * density_prime * gravity;
 }

◆ execute()

void RichardsSUPG::execute ( )

virtualinherited

Implements GeneralUserObject.

Definition at line 30 of file RichardsSUPG.C.

31 {

32 }

◆ finalize()

void RichardsSUPG::finalize ( )

virtualinherited

Implements GeneralUserObject.

Definition at line 35 of file RichardsSUPG.C.

36 {

37 }

◆ initialize()

void RichardsSUPG::initialize ( )

virtualinherited

Implements GeneralUserObject.

Definition at line 25 of file RichardsSUPG.C.

26 {

27 }

◆ SUPG_trivial()

bool RichardsSUPGstandard::SUPG_trivial ( ) const

virtual

returns false in this case since everything is trivial

Implements RichardsSUPG.

Definition at line 219 of file RichardsSUPGstandard.C.

 {
   return false;
 }

◆ tauSUPG()

Real RichardsSUPGstandard::tauSUPG	(	RealVectorValue	vel,
		Real	traceperm,
		RealVectorValue	b
	)		const

virtual

The SUPG tau parameter.

This dictates how strong the SUPG is

Parameters

vel	SUPG velocity
traceperm	trace of the permeability tensor for the material
b	the b parameter: \|b\| ~ 2*SUPGvelocity/element_length

Implements RichardsSUPG.

Definition at line 129 of file RichardsSUPGstandard.C.

 {
   // vel = velocity, b = bb
   Real norm_v = vel.norm();
   Real norm_b = b.norm(); // Hughes et al investigate infinity-norm and 2-norm.  i just use 2-norm
                           // here.   norm_b ~ 2|a|/ele_length_in_direction_of_a
 
   if (norm_b == 0)
     return 0.0; // Only way for norm_b=0 is for zero ele size, or vel=0.  Either way we don't have
                 // to upwind.
 
   Real h = 2.0 * norm_v / norm_b; // h is a measure of the element length in the "a" direction
   Real alpha = 0.5 * norm_v * h / (traceperm * _p_SUPG); // this is the Peclet number
 
   const Real xi_tilde = RichardsSUPGstandard::cosh_relation(alpha);
 
   return xi_tilde / norm_b;
 }

◆ validParams()

InputParameters RichardsSUPGstandard::validParams ( )

static

Definition at line 16 of file RichardsSUPGstandard.C.

 {
   InputParameters params = RichardsSUPG::validParams();
   params.addRequiredRangeCheckedParam<Real>(
       "p_SUPG",
       "p_SUPG > 0",
       "SUPG pressure.  This parameter controls the strength of the "
       "upwinding.  This parameter must be positive.  If you need to track "
       "advancing fronts in a problem, then set to less than your expected "
       "range of pressures in your unsaturated zone.  Otherwise, set "
       "larger, and then minimal upwinding will occur and convergence will "
       "typically be good.  If you need no SUPG, it is more efficient not "
       "to use this UserObject.");
   params.addClassDescription(
       "Standard SUPG relationships for Richards flow based on Appendix A of      TJR Hughes, M "
       "Mallet and A Mizukami ``A new finite element formulation for computational fluid dynamics:: "
       "II. Behond SUPG'' Computer Methods in Applied Mechanics and Engineering 54 (1986) 341--355");
   return params;
 }

◆ velSUPG()

RealVectorValue RichardsSUPGstandard::velSUPG	(	RealTensorValue	perm,
		RealVectorValue	gradp,
		Real	density,
		RealVectorValue	gravity
	)		const

virtual

SUPG velocity = -perm*(gradp - density*gravity) This points in direction of information propagation.

Parameters

perm	permeability tensor
gradp	gradient of porepressure
density	fluid density
gravity	gravitational acceleration vector

Implements RichardsSUPG.

Definition at line 42 of file RichardsSUPGstandard.C.

 {
   return -perm * (gradp - density * gravity); // points in direction of info propagation
 }

Member Data Documentation

◆ _p_SUPG

Real RichardsSUPGstandard::_p_SUPG

protected

the SUPG pressure parameter This dictates how strong the SUPG is _p_SUPG large means only a little SUPG _p_SUPG small means close to fully-upwind

Definition at line 144 of file RichardsSUPGstandard.h.

Referenced by dtauSUPG_dgradp(), dtauSUPG_dp(), and tauSUPG().

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

richards/include/userobjects/RichardsSUPGstandard.h
richards/src/userobjects/RichardsSUPGstandard.C

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

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RichardsSUPGstandard()

Member Function Documentation

◆ bb()

◆ cosh_relation()

◆ cosh_relation_prime()

◆ dbb2_dgradp()

◆ dbb2_dp()

◆ dtauSUPG_dgradp()

◆ dtauSUPG_dp()

◆ dvelSUPG_dgradp()

◆ dvelSUPG_dp()

◆ execute()

◆ finalize()

◆ initialize()

◆ SUPG_trivial()

◆ tauSUPG()

◆ validParams()

◆ velSUPG()

Member Data Documentation

◆ _p_SUPG