Applies a flux to a boundary such that fluid or heat will flow freely out of the boundary. More...

#include <PorousFlowOutflowBC.h>

Inheritance diagram for PorousFlowOutflowBC:

Public Types
enum	ResidualTagType { ResidualTagType::NonReference, ResidualTagType::Reference }

enum	TEST_TYPE

typedef DataFileName	DataFileParameterType

Public Member Functions
	PorousFlowOutflowBC (const InputParameters &parameters)

virtual const MooseVariable &	variable () const override

virtual void	computeResidual () override

virtual void	computeJacobian () override

virtual void	computeOffDiagJacobian (unsigned int jvar) override

void	computeOffDiagJacobianScalar (unsigned int jvar) override

virtual void	computeResidualAndJacobian () override

void	prepareShapes (unsigned int var_num) override final

virtual bool	shouldApply () const override

virtual void	computeNonlocalJacobian ()

virtual void	computeNonlocalOffDiagJacobian (unsigned int)

const SubProblem &	subProblem () const

virtual std::set< std::string >	additionalROVariables ()

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

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

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

void	setRandomResetFrequency (ExecFlagType exec_flag)

unsigned long	getRandomLong () const

Real	getRandomReal () const

unsigned int	getSeed (std::size_t id)

unsigned int	getMasterSeed () const

bool	isNodal () const

ExecFlagType	getResetOnTime () const

void	setRandomDataPointer (RandomData *random_data)

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

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

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 const VariableValue &	coupledValueByName (const std::string &var_name)

virtual const ArrayVariableValue &	coupledArrayValueByName (const std::string &var_name)

const std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > &	getCoupledVars () const

const std::vector< MooseVariableFieldBase *> &	getCoupledMooseVars () const

const std::vector< MooseVariable *> &	getCoupledStandardMooseVars () const

const std::vector< VectorMooseVariable *> &	getCoupledVectorMooseVars () const

const std::vector< ArrayMooseVariable *> &	getCoupledArrayMooseVars () const

void	addFEVariableCoupleableVectorTag (TagID tag)

void	addFEVariableCoupleableMatrixTag (TagID tag)

std::set< TagID > &	getFEVariableCoupleableVectorTags ()

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

std::set< TagID > &	getFEVariableCoupleableMatrixTags ()

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

auto &	getWritableCoupledVariables () const

bool	hasWritableCoupledVariables () const

const ADVariableValue *	getADDefaultValue (const std::string &var_name) const

const ADVectorVariableValue *	getADDefaultVectorValue (const std::string &var_name) const

const ADVariableGradient &	getADDefaultGradient () const

const ADVectorVariableGradient &	getADDefaultVectorGradient () const

const ADVariableSecond &	getADDefaultSecond () const

const ADVectorVariableCurl &	getADDefaultCurl () const

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

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

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () 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)

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)

MooseVariableBase *	mooseVariableBase () const

MooseVariableField< Real > &	mooseVariableField ()

MooseVariableFE< Real > *	mooseVariable () const

MooseVariableFV< Real > *	mooseVariableFV () const

MooseLinearVariableFV< Real > *	mooseLinearVariableFV () 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 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 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 Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static bool	restricted (const std::set< BoundaryID > &ids)

Public Attributes
	ALL

	ANY

const ConsoleStream	_console

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

Protected Types
enum	FluxTypeChoiceEnum { FluxTypeChoiceEnum::FLUID, FluxTypeChoiceEnum::HEAT }
	Indicates the type of flux that this BC will apply. More...

Protected Member Functions
virtual Real	computeQpResidual () override

virtual Real	computeQpJacobian () override

virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override

virtual Real	computeQpOffDiagJacobianScalar (unsigned int jvar)

virtual void	precalculateQpResidual ()

virtual void	precalculateQpJacobian ()

virtual void	precalculateQpOffDiagJacobian (const MooseVariableFEBase &)

virtual void	precalculateResidual ()

virtual void	precalculateJacobian ()

virtual void	precalculateOffDiagJacobian (unsigned int)

const MooseVariableFieldBase &	getVariable (unsigned int jvar_num) const

virtual void	addUserObjectDependencyHelper (const UserObject &) const

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) 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

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

bool	hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const

virtual void	coupledCallback (const std::string &, bool) const

virtual bool	isCoupled (const std::string &var_name, unsigned int i=0) const

virtual bool	isCoupledConstant (const std::string &var_name) const

unsigned int	coupledComponents (const std::string &var_name) const

VariableName	coupledName (const std::string &var_name, unsigned int comp=0) const

std::vector< VariableName >	coupledNames (const std::string &var_name) const

virtual unsigned int	coupled (const std::string &var_name, unsigned int comp=0) const

std::vector< unsigned int >	coupledIndices (const std::string &var_name) const

virtual const VariableValue &	coupledValue (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledValues (const std::string &var_name) const

std::vector< const VectorVariableValue *>	coupledVectorValues (const std::string &var_name) const

const GenericVariableValue< is_ad > &	coupledGenericValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericValue (const std::string &var_name, unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericValue (const std::string &var_name, unsigned int comp) const

const GenericVectorVariableValue< is_ad > &	coupledGenericVectorValue (const std::string &var_name, unsigned int comp=0) const

const GenericVectorVariableValue< false > &	coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const

const GenericVectorVariableValue< true > &	coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const

std::vector< const GenericVariableValue< is_ad > *>	coupledGenericValues (const std::string &var_name) const

std::vector< const GenericVariableValue< false > *>	coupledGenericValues (const std::string &var_name) const

std::vector< const GenericVariableValue< true > *>	coupledGenericValues (const std::string &var_name) const

const GenericVariableValue< is_ad > &	coupledGenericDofValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericDofValue (const std::string &var_name, unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericDofValue (const std::string &var_name, unsigned int comp) const

const GenericVariableValue< is_ad > &	coupledGenericDot (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericDot (const std::string &var_name, unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericDot (const std::string &var_name, unsigned int comp) const

const GenericVariableValue< is_ad > &	coupledGenericDotDot (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericDotDot (const std::string &var_name, unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericDotDot (const std::string &var_name, unsigned int comp) const

virtual const VariableValue &	coupledValueLower (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledValue (const std::string &var_name, unsigned int comp=0) const

std::vector< const ADVariableValue *>	adCoupledValues (const std::string &var_name) const

const ADVariableValue &	adCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const

const ADVectorVariableValue &	adCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const

std::vector< const ADVectorVariableValue *>	adCoupledVectorValues (const std::string &var_name) const

virtual const VariableValue &	coupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const VariableValue &	coupledVectorTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableValue *>	coupledVectorTagValues (const std::string &var_names, TagID tag) const

std::vector< const VariableValue *>	coupledVectorTagValues (const std::string &var_names, const std::string &tag_name) const

virtual const ArrayVariableValue &	coupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const ArrayVariableValue &	coupledVectorTagArrayValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const ArrayVariableValue *>	coupledVectorTagArrayValues (const std::string &var_names, TagID tag) const

std::vector< const ArrayVariableValue *>	coupledVectorTagArrayValues (const std::string &var_names, const std::string &tag_name) const

virtual const VariableGradient &	coupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const VariableGradient &	coupledVectorTagGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableGradient *>	coupledVectorTagGradients (const std::string &var_names, TagID tag) const

std::vector< const VariableGradient *>	coupledVectorTagGradients (const std::string &var_names, const std::string &tag_name) const

virtual const ArrayVariableGradient &	coupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const ArrayVariableGradient &	coupledVectorTagArrayGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const ArrayVariableGradient *>	coupledVectorTagArrayGradients (const std::string &var_names, TagID tag) const

std::vector< const ArrayVariableGradient *>	coupledVectorTagArrayGradients (const std::string &var_names, const std::string &tag_name) const

virtual const VariableValue &	coupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const

virtual const VariableValue &	coupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

const ArrayVariableValue &	coupledVectorTagArrayDofValue (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledVectorTagDofValues (const std::string &var_names, TagID tag) const

std::vector< const VariableValue *>	coupledVectorTagDofValues (const std::string &var_names, const std::string &tag_name) const

virtual const VariableValue &	coupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const VariableValue &	coupledMatrixTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableValue *>	coupledMatrixTagValues (const std::string &var_names, TagID tag) const

std::vector< const VariableValue *>	coupledMatrixTagValues (const std::string &var_names, const std::string &tag_name) const

virtual const VectorVariableValue &	coupledVectorValue (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayValue (const std::string &var_name, unsigned int comp=0) const

std::vector< const ArrayVariableValue *>	coupledArrayValues (const std::string &var_name) const

MooseWritableVariable &	writableVariable (const std::string &var_name, unsigned int comp=0)

virtual VariableValue &	writableCoupledValue (const std::string &var_name, unsigned int comp=0)

void	checkWritableVar (MooseWritableVariable *var)

virtual const VariableValue &	coupledValueOld (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledValuesOld (const std::string &var_name) const

std::vector< const VectorVariableValue *>	coupledVectorValuesOld (const std::string &var_name) const

virtual const VariableValue &	coupledValueOlder (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledValuesOlder (const std::string &var_name) const

virtual const VariableValue &	coupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradient (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableGradient *>	coupledGradients (const std::string &var_name) const

const ADVariableGradient &	adCoupledGradient (const std::string &var_name, unsigned int comp=0) const

const ADVariableGradient &	adCoupledGradientDot (const std::string &var_name, unsigned int comp=0) const

std::vector< const ADVariableGradient *>	adCoupledGradients (const std::string &var_name) const

const GenericVariableGradient< is_ad > &	coupledGenericGradient (const std::string &var_name, unsigned int comp=0) const

const GenericVariableGradient< false > &	coupledGenericGradient (const std::string &var_name, unsigned int comp) const

const GenericVariableGradient< true > &	coupledGenericGradient (const std::string &var_name, unsigned int comp) const

std::vector< const GenericVariableGradient< is_ad > *>	coupledGenericGradients (const std::string &var_name) const

std::vector< const GenericVariableGradient< false > *>	coupledGenericGradients (const std::string &var_name) const

std::vector< const GenericVariableGradient< true > *>	coupledGenericGradients (const std::string &var_name) const

const ADVectorVariableGradient &	adCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const

const ADVariableSecond &	adCoupledSecond (const std::string &var_name, unsigned int comp=0) const

const ADVectorVariableSecond &	adCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradientOld (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableGradient *>	coupledGradientsOld (const std::string &var_name) const

virtual const VariableGradient &	coupledGradientOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradientDot (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableGradient &	coupledVectorGradient (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableGradient &	coupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableGradient &	coupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradient (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableCurl &	coupledCurl (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableCurl &	coupledCurlOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableCurl &	coupledCurlOlder (const std::string &var_name, unsigned int comp=0) const

const ADVectorVariableCurl &	adCoupledCurl (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableDivergence &	coupledDiv (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableDivergence &	coupledDivOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableDivergence &	coupledDivOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecond (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecondOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecondOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDot (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledDots (const std::string &var_name) const

virtual const VariableValue &	coupledDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDotDotOld (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledDot (const std::string &var_name, unsigned int comp=0) const

std::vector< const ADVariableValue *>	adCoupledDots (const std::string &var_name) const

const ADVariableValue &	adCoupledDotDot (const std::string &var_name, unsigned int comp=0) const

const ADVectorVariableValue &	adCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayDot (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDotDu (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDotDotDu (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledArrayDotDu (const std::string &var_name, unsigned int comp=0) const

const T &	coupledNodalValue (const std::string &var_name, unsigned int comp=0) const

const Moose::ADType< T >::type &	adCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const

const T &	coupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const

const T &	coupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const

const T &	coupledNodalValuePreviousNL (const std::string &var_name, unsigned int comp=0) const

const T &	coupledNodalDot (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDofValues (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledAllDofValues (const std::string &var_name) const

virtual const VariableValue &	coupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledAllDofValuesOld (const std::string &var_name) const

virtual const VariableValue &	coupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledAllDofValuesOlder (const std::string &var_name) const

virtual const ArrayVariableValue &	coupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const

virtual const ADVariableValue &	adCoupledDofValues (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adZeroValue () const

const ADVariableGradient &	adZeroGradient () const

const ADVariableSecond &	adZeroSecond () const

const GenericVariableValue< is_ad > &	genericZeroValue ()

const GenericVariableValue< false > &	genericZeroValue ()

const GenericVariableValue< true > &	genericZeroValue ()

const GenericVariableGradient< is_ad > &	genericZeroGradient ()

const GenericVariableGradient< false > &	genericZeroGradient ()

const GenericVariableGradient< true > &	genericZeroGradient ()

const GenericVariableSecond< is_ad > &	genericZeroSecond ()

const GenericVariableSecond< false > &	genericZeroSecond ()

const GenericVariableSecond< true > &	genericZeroSecond ()

bool	checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const

const MooseVariableFieldBase *	getFEVar (const std::string &var_name, unsigned int comp) const

const MooseVariableFieldBase *	getFieldVar (const std::string &var_name, unsigned int comp) const

MooseVariableFieldBase *	getFieldVar (const std::string &var_name, unsigned int comp)

const T *	getVarHelper (const std::string &var_name, unsigned int comp) const

T *	getVarHelper (const std::string &var_name, unsigned int comp)

MooseVariable *	getVar (const std::string &var_name, unsigned int comp)

const MooseVariable *	getVar (const std::string &var_name, unsigned int comp) const

VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp)

const VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp) const

ArrayMooseVariable *	getArrayVar (const std::string &var_name, unsigned int comp)

const ArrayMooseVariable *	getArrayVar (const std::string &var_name, unsigned int comp) const

void	validateExecutionerType (const std::string &name, const std::string &fn_name) const

std::vector< T >	coupledVectorHelper (const std::string &var_name, const Func &func) 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 ()

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

Protected Attributes
const PorousFlowDictator &	_dictator
	PorousFlowDictator UserObject. More...

const unsigned	_num_phases
	Number of phases in the simulation. More...

const bool	_perm_derivs
	Flag indicating whether to include derivatives of the permeability in the Jacobian. More...

enum PorousFlowOutflowBC::FluxTypeChoiceEnum	_flux_type

const unsigned int	_sp
	The fluid component number (only used if _flux_type==FLUID)) More...

const bool	_multiply_by_density
	Whether to multiply the Darcy flux by the fluid density. This is automatically set to true if _flux_type==HEAT. More...

const bool	_include_relperm
	Whether to multiply the Darcy flux by the relative permeability. More...

const RealVectorValue	_gravity
	Gravitational acceleration. More...

const Real	_multiplier
	Multiply the flux by this quantity. This is mainly used for testing purposes, for instance, testing the Jacobian, and should ordinarily set to its default value of 1.0. More...

const MaterialProperty< std::vector< RealGradient > > &	_grad_p
	Gradient of the pore pressure in each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dgrad_p_dgrad_var
	Derivative of Grad porepressure in each phase wrt grad(PorousFlow variables) More...

const MaterialProperty< std::vector< std::vector< RealGradient > > > &	_dgrad_p_dvar
	Derivative of Grad porepressure in each phase wrt PorousFlow variables. More...

const MaterialProperty< std::vector< Real > > &	_fluid_density_qp
	Fluid density for each phase (at the qp) More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dfluid_density_qp_dvar
	Derivative of the fluid density for each phase wrt PorousFlow variables (at the qp) More...

const MaterialProperty< RealTensorValue > &	_permeability
	Permeability of porous material. More...

const MaterialProperty< std::vector< RealTensorValue > > &	_dpermeability_dvar
	d(permeabiity)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< std::vector< RealTensorValue > > > &	_dpermeability_dgradvar
	d(permeabiity)/d(grad(PorousFlow variable)) More...

const MaterialProperty< std::vector< Real > > &	_fluid_viscosity
	Viscosity of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dfluid_viscosity_dvar
	Derivative of the fluid viscosity for each phase wrt PorousFlow variables. More...

const bool	_has_density
	Whether there is a fluid_phase_density_nodal Material. More...

const bool	_has_mass_fraction
	Whether there is a mass_frac_nodal Material. More...

const bool	_has_relperm
	Whether there is a relative_permeability_nodal Material. More...

const bool	_has_enthalpy
	Whether there is an enthalpy Material. More...

const bool	_has_thermal_conductivity
	Whether there is a thermal_conductivity_qp Material. More...

const bool	_has_t
	Whether there is a grad_temp Material. More...

const MaterialProperty< std::vector< Real > > *const	_fluid_density_node
	Fluid density for each phase (at the node) More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_density_node_dvar
	d(Fluid density for each phase (at the node))/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_relative_permeability
	Relative permeability of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_drelative_permeability_dvar
	d(Relative permeability of each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_mass_fractions
	Mass fraction of each component in each phase. More...

const MaterialProperty< std::vector< std::vector< std::vector< Real > > > > *const	_dmass_fractions_dvar
	d(Mass fraction of each component in each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_enthalpy
	Enthalpy of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_denthalpy_dvar
	d(enthalpy of each phase)/d(PorousFlow variable) More...

const MaterialProperty< RealTensorValue > *const	_thermal_conductivity
	Thermal_Conductivity of porous material. More...

const MaterialProperty< std::vector< RealTensorValue > > *const	_dthermal_conductivity_dvar
	d(Thermal_Conductivity)/d(PorousFlow variable) More...

const MaterialProperty< RealGradient > *const	_grad_t
	grad(temperature) More...

const MaterialProperty< std::vector< RealGradient > > *const	_dgrad_t_dvar
	d(gradT)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_dgrad_t_dgradvar
	d(gradT)/d(grad PorousFlow variable) More...

MooseVariable &	_var

const MooseArray< Point > &	_normals

const VariablePhiValue &	_phi

const VariablePhiGradient &	_grad_phi

const VariableTestValue &	_test

const VariableTestGradient &	_grad_test

const VariableValue &	_u

const VariableGradient &	_grad_u

const Elem *const &	_current_elem

const Real &	_current_elem_volume

const unsigned int &	_current_side

const Elem *const &	_current_side_elem

const Real &	_current_side_volume

const BoundaryID &	_current_boundary_id

unsigned int	_qp

const QBase *const &	_qrule

const MooseArray< Point > &	_q_point

const MooseArray< Real > &	_JxW

const MooseArray< Real > &	_coord

unsigned int	_i

unsigned int	_j

bool	_has_save_in

std::vector< MooseVariableFEBase *>	_save_in

std::vector< AuxVariableName >	_save_in_strings

bool	_has_diag_save_in

std::vector< MooseVariableFEBase *>	_diag_save_in

std::vector< AuxVariableName >	_diag_save_in_strings

const bool	_skip_execution_outside_variable_domain

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

THREAD_ID	_tid

Assembly &	_assembly

MooseMesh &	_mesh

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

bool	_is_implicit

Real &	_t

const Real &	_t_old

int &	_t_step

Real &	_dt

Real &	_dt_old

bool	_is_transient

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

DenseVector< Number >	_local_re

DenseMatrix< Number >	_local_ke

DenseMatrix< Number >	_nonlocal_ke

GeometricSearchData &	_geometric_search_data

bool	_requires_geometric_search

const InputParameters &	_c_parameters

const std::string &	_c_name

const std::string &	_c_type

FEProblemBase &	_c_fe_problem

const SystemBase *const	_c_sys

std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> >	_coupled_vars

std::vector< MooseVariableFieldBase *>	_coupled_moose_vars

std::vector< MooseVariable *>	_coupled_standard_moose_vars

std::vector< VectorMooseVariable *>	_coupled_vector_moose_vars

std::vector< ArrayMooseVariable *>	_coupled_array_moose_vars

std::vector< MooseVariableFV< Real > *>	_coupled_standard_fv_moose_vars

std::vector< MooseLinearVariableFV< Real > *>	_coupled_standard_linear_fv_moose_vars

const std::unordered_map< std::string, std::string > &	_new_to_deprecated_coupled_vars

bool	_c_nodal

bool	_c_is_implicit

const bool	_c_allow_element_to_nodal_coupling

THREAD_ID	_c_tid

std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > >	_default_value

std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > >	_ad_default_value

std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > >	_default_vector_value

std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > >	_default_array_value

std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > >	_ad_default_vector_value

VariableValue	_default_value_zero

VariableGradient	_default_gradient

MooseArray< ADRealVectorValue >	_ad_default_gradient

MooseArray< ADRealTensorValue >	_ad_default_vector_gradient

VariableSecond	_default_second

MooseArray< ADRealTensorValue >	_ad_default_second

MooseArray< ADRealVectorValue >	_ad_default_curl

const VariableValue &	_zero

const VariablePhiValue &	_phi_zero

const MooseArray< ADReal > &	_ad_zero

const VariableGradient &	_grad_zero

const MooseArray< ADRealVectorValue > &	_ad_grad_zero

const VariablePhiGradient &	_grad_phi_zero

const VariableSecond &	_second_zero

const MooseArray< ADRealTensorValue > &	_ad_second_zero

const VariablePhiSecond &	_second_phi_zero

const VectorVariableValue &	_vector_zero

const VectorVariableCurl &	_vector_curl_zero

VectorVariableValue	_default_vector_value_zero

VectorVariableGradient	_default_vector_gradient

VectorVariableCurl	_default_vector_curl

VectorVariableDivergence	_default_div

ArrayVariableValue	_default_array_value_zero

ArrayVariableGradient	_default_array_gradient

bool	_coupleable_neighbor

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

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

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Private Member Functions
Real	jac (unsigned int jvar) const
	Derivative of residual with respect to the jvar variable. More...

Real	darcy (unsigned ph) const
	Darcy contribution to the outflowBC. More...

Real	mobility (unsigned ph) const
	Mobility contribution to the outflowBC. More...

Real	prefactor (unsigned ph) const
	Either mass_fraction or enthalpy, depending on _flux_type. More...

Detailed Description

Applies a flux to a boundary such that fluid or heat will flow freely out of the boundary.

Definition at line 18 of file PorousFlowOutflowBC.h.

Member Enumeration Documentation

◆ FluxTypeChoiceEnum

enum PorousFlowOutflowBC::FluxTypeChoiceEnum

strongprotected

Indicates the type of flux that this BC will apply.

Enumerator
FLUID
HEAT

Definition at line 40 of file PorousFlowOutflowBC.h.

40 { FLUID, HEAT } _flux_type;

PorousFlowOutflowBC::_flux_type

enum PorousFlowOutflowBC::FluxTypeChoiceEnum _flux_type

Constructor & Destructor Documentation

◆ PorousFlowOutflowBC()

PorousFlowOutflowBC::PorousFlowOutflowBC ( const InputParameters & parameters )

Definition at line 62 of file PorousFlowOutflowBC.C.

   : IntegratedBC(parameters),
     _dictator(getUserObject<PorousFlowDictator>("PorousFlowDictator")),
     _num_phases(_dictator.numPhases()),
     _perm_derivs(_dictator.usePermDerivs()),
     _flux_type(getParam<MooseEnum>("flux_type").getEnum<FluxTypeChoiceEnum>()),
     _sp(getParam<unsigned>("mass_fraction_component")),
     _multiply_by_density(
         _flux_type == FluxTypeChoiceEnum::FLUID ? getParam<bool>("multiply_by_density") : true),
     _include_relperm(getParam<bool>("include_relperm")),
     _gravity(getParam<RealVectorValue>("gravity")),
     _multiplier(getParam<Real>("multiplier")),
     _grad_p(getMaterialProperty<std::vector<RealGradient>>("PorousFlow_grad_porepressure_qp")),
     _dgrad_p_dgrad_var(getMaterialProperty<std::vector<std::vector<Real>>>(
         "dPorousFlow_grad_porepressure_qp_dgradvar")),
     _dgrad_p_dvar(getMaterialProperty<std::vector<std::vector<RealGradient>>>(
         "dPorousFlow_grad_porepressure_qp_dvar")),
     _fluid_density_qp(getMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_qp")),
     _dfluid_density_qp_dvar(getMaterialProperty<std::vector<std::vector<Real>>>(
         "dPorousFlow_fluid_phase_density_qp_dvar")),
     _permeability(getMaterialProperty<RealTensorValue>("PorousFlow_permeability_qp")),
     _dpermeability_dvar(
         getMaterialProperty<std::vector<RealTensorValue>>("dPorousFlow_permeability_qp_dvar")),
     _dpermeability_dgradvar(getMaterialProperty<std::vector<std::vector<RealTensorValue>>>(
         "dPorousFlow_permeability_qp_dgradvar")),
     _fluid_viscosity(getMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_nodal")),
     _dfluid_viscosity_dvar(
         getMaterialProperty<std::vector<std::vector<Real>>>("dPorousFlow_viscosity_nodal_dvar")),
 
     _has_density(hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_nodal") &&
                  hasMaterialProperty<std::vector<std::vector<Real>>>(
                      "dPorousFlow_fluid_phase_density_nodal_dvar")),
     _has_mass_fraction(
         hasMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_nodal") &&
         hasMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
             "dPorousFlow_mass_frac_nodal_dvar")),
     _has_relperm(hasMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_nodal") &&
                  hasMaterialProperty<std::vector<std::vector<Real>>>(
                      "dPorousFlow_relative_permeability_nodal_dvar")),
     _has_enthalpy(hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_enthalpy_nodal") &&
                   hasMaterialProperty<std::vector<std::vector<Real>>>(
                       "dPorousFlow_fluid_phase_enthalpy_nodal_dvar")),
     _has_thermal_conductivity(
         hasMaterialProperty<RealTensorValue>("PorousFlow_thermal_conductivity_qp") &&
         hasMaterialProperty<std::vector<RealTensorValue>>(
             "dPorousFlow_thermal_conductivity_qp_dvar")),
     _has_t(hasMaterialProperty<RealGradient>("PorousFlow_grad_temperature_qp") &&
            hasMaterialProperty<std::vector<RealGradient>>("dPorousFlow_grad_temperature_qp_dvar") &&
            hasMaterialProperty<std::vector<Real>>("dPorousFlow_grad_temperature_qp_dgradvar")),
 
     _fluid_density_node(_has_density ? &getMaterialProperty<std::vector<Real>>(
                                            "PorousFlow_fluid_phase_density_nodal")
                                      : nullptr),
     _dfluid_density_node_dvar(_has_density ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                  "dPorousFlow_fluid_phase_density_nodal_dvar")
                                            : nullptr),
     _relative_permeability(_has_relperm ? &getMaterialProperty<std::vector<Real>>(
                                               "PorousFlow_relative_permeability_nodal")
                                         : nullptr),
     _drelative_permeability_dvar(_has_relperm
                                      ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                            "dPorousFlow_relative_permeability_nodal_dvar")
                                      : nullptr),
     _mass_fractions(_has_mass_fraction ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                              "PorousFlow_mass_frac_nodal")
                                        : nullptr),
     _dmass_fractions_dvar(_has_mass_fraction
                               ? &getMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
                                     "dPorousFlow_mass_frac_nodal_dvar")
                               : nullptr),
     _enthalpy(_has_enthalpy ? &getMaterialPropertyByName<std::vector<Real>>(
                                   "PorousFlow_fluid_phase_enthalpy_nodal")
                             : nullptr),
     _denthalpy_dvar(_has_enthalpy ? &getMaterialPropertyByName<std::vector<std::vector<Real>>>(
                                         "dPorousFlow_fluid_phase_enthalpy_nodal_dvar")
                                   : nullptr),
     _thermal_conductivity(_has_thermal_conductivity ? &getMaterialProperty<RealTensorValue>(
                                                           "PorousFlow_thermal_conductivity_qp")
                                                     : nullptr),
     _dthermal_conductivity_dvar(_has_thermal_conductivity
                                     ? &getMaterialProperty<std::vector<RealTensorValue>>(
                                           "dPorousFlow_thermal_conductivity_qp_dvar")
                                     : nullptr),
     _grad_t(_has_t ? &getMaterialProperty<RealGradient>("PorousFlow_grad_temperature_qp")
                    : nullptr),
     _dgrad_t_dvar(_has_t ? &getMaterialProperty<std::vector<RealGradient>>(
                                "dPorousFlow_grad_temperature_qp_dvar")
                          : nullptr),
     _dgrad_t_dgradvar(
         _has_t ? &getMaterialProperty<std::vector<Real>>("dPorousFlow_grad_temperature_qp_dgradvar")
                : nullptr)
 {
   if (_flux_type == FluxTypeChoiceEnum::FLUID && _sp >= _dictator.numComponents())
     paramError("mass_fraction_component",
                "The Dictator declares that the maximum fluid component index is ",
                _dictator.numComponents() - 1,
                ", but you have set mass_fraction_component to ",
                _sp,
                ". Remember that indexing starts at 0. Please be assured that the Dictator has "
                "noted your error.");
 
   if (_multiply_by_density && !_has_density)
     mooseError("PorousFlowOutflowBC: You requested to multiply_by_density, but you have no nodal "
                "fluid density Material");
   if (_include_relperm && !_has_relperm)
     mooseError("PorousFlowOutflowBC: You requested to include the relative permeability, but you "
                "have no nodal relative permeability Material");
   if (_flux_type == FluxTypeChoiceEnum::FLUID && !_has_mass_fraction)
     mooseError(
         "PorousFlowOutflowBC: For flux_type = fluid, you need a nodal mass-fraction Material");
   if (_flux_type == FluxTypeChoiceEnum::HEAT && !_has_enthalpy)
     mooseError(
         "PorousFlowOutflowBC: For flux_type = heat, you need a nodal fluid enthalpy Material");
   if (_flux_type == FluxTypeChoiceEnum::HEAT && !_has_thermal_conductivity)
     mooseError(
         "PorousFlowOutflowBC: For flux_type = heat, you need a thermal conductivity Material");
   if (_flux_type == FluxTypeChoiceEnum::HEAT && !_has_t)
     mooseError("PorousFlowOutflowBC: For flux_type = heat, you need a temperature Material");
 }

Member Function Documentation

◆ computeQpJacobian()

Real PorousFlowOutflowBC::computeQpJacobian ( )

overrideprotectedvirtual

Reimplemented from IntegratedBC.

Definition at line 197 of file PorousFlowOutflowBC.C.

 {
   return jac(_var.number());
 }

◆ computeQpOffDiagJacobian()

Real PorousFlowOutflowBC::computeQpOffDiagJacobian ( unsigned int jvar )

overrideprotectedvirtual

Reimplemented from IntegratedBC.

Definition at line 203 of file PorousFlowOutflowBC.C.

 {
   return jac(jvar);
 }

◆ computeQpResidual()

Real PorousFlowOutflowBC::computeQpResidual ( )

overrideprotectedvirtual

Implements IntegratedBC.

Definition at line 183 of file PorousFlowOutflowBC.C.

 {
   Real advective_term = 0.0;
   for (unsigned ph = 0; ph < _num_phases; ++ph)
     advective_term -= darcy(ph) * mobility(ph) * prefactor(ph);
 
   if (_flux_type == FluxTypeChoiceEnum::FLUID)
     return _test[_i][_qp] * advective_term * _multiplier;
 
   const Real conduction_term = -_normals[_qp] * ((*_thermal_conductivity)[_qp] * (*_grad_t)[_qp]);
   return _test[_i][_qp] * (conduction_term + advective_term) * _multiplier;
 }

◆ darcy()

Real PorousFlowOutflowBC::darcy ( unsigned ph ) const

private

Darcy contribution to the outflowBC.

Definition at line 282 of file PorousFlowOutflowBC.C.

Referenced by computeQpResidual(), and jac().

 {
   return _normals[_qp] *
          (_permeability[_qp] * (_grad_p[_qp][ph] - _fluid_density_qp[_qp][ph] * _gravity));
 }

◆ jac()

Real PorousFlowOutflowBC::jac ( unsigned int jvar ) const

private

Derivative of residual with respect to the jvar variable.

Definition at line 209 of file PorousFlowOutflowBC.C.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

 {
   if (_dictator.notPorousFlowVariable(jvar))
     return 0.0;
   const unsigned int pvar = _dictator.porousFlowVariableNum(jvar);
 
   // For _i != _j, note:
   // since the only non-upwinded contribution to the residual is
   // from Darcy and thermal_conductivity, the only contribution
   // of the residual at node _i from changing jvar at node _j is through
   // the derivative of Darcy or thermal_conductivity
 
   Real advective_term_prime = 0.0;
   for (unsigned ph = 0; ph < _num_phases; ++ph)
   {
     Real darcyprime =
         _normals[_qp] *
         (_permeability[_qp] * (_grad_phi[_j][_qp] * _dgrad_p_dgrad_var[_qp][ph][pvar] +
                                _dgrad_p_dvar[_qp][ph][pvar] * _phi[_j][_qp] -
                                _dfluid_density_qp_dvar[_qp][ph][pvar] * _phi[_j][_qp] * _gravity));
     if (_perm_derivs)
     {
       darcyprime += _normals[_qp] * (_dpermeability_dvar[_qp][pvar] * _phi[_j][_qp] *
                                      (_grad_p[_qp][ph] - _fluid_density_qp[_qp][ph] * _gravity));
       for (const auto i : make_range(Moose::dim))
         darcyprime +=
             _normals[_qp] * (_dpermeability_dgradvar[_qp][i][pvar] * _grad_phi[_j][_qp](i) *
                              (_grad_p[_qp][ph] - _fluid_density_qp[_qp][ph] * _gravity));
     }
     if (_i != _j)
       advective_term_prime -= prefactor(ph) * mobility(ph) * darcyprime;
     else
     {
       const Real dar = darcy(ph);
 
       Real mob = 1.0 / _fluid_viscosity[_i][ph];
       Real mobprime =
           -_dfluid_viscosity_dvar[_i][ph][pvar] / Utility::pow<2>(_fluid_viscosity[_i][ph]);
       if (_multiply_by_density)
       {
         const Real densityprime = (*_dfluid_density_node_dvar)[_i][ph][pvar];
         mobprime = densityprime * mob + (*_fluid_density_node)[_i][ph] * mobprime;
         mob *= (*_fluid_density_node)[_i][ph];
       }
       if (_include_relperm)
       {
         const Real relpermprime = (*_drelative_permeability_dvar)[_i][ph][pvar];
         mobprime = relpermprime * mob + (*_relative_permeability)[_i][ph] * mobprime;
         mob *= (*_relative_permeability)[_i][ph];
       }
 
       const Real pre = prefactor(ph);
       const Real preprime =
           (_flux_type == FluxTypeChoiceEnum::FLUID ? (*_dmass_fractions_dvar)[_i][ph][_sp][pvar]
                                                    : (*_denthalpy_dvar)[_i][ph][pvar]);
 
       advective_term_prime -= preprime * mob * dar + pre * mobprime * dar + pre * mob * darcyprime;
     }
   }
   if (_flux_type == FluxTypeChoiceEnum::FLUID)
     return _test[_i][_qp] * advective_term_prime * _multiplier;
 
   const Real conduction_term_prime =
       -_normals[_qp] *
           ((*_dthermal_conductivity_dvar)[_qp][pvar] * (*_grad_t)[_qp] +
            (*_thermal_conductivity)[_qp] * (*_dgrad_t_dvar)[_qp][pvar]) *
           _phi[_j][_qp] -
       _normals[_qp] *
           ((*_thermal_conductivity)[_qp] * (*_dgrad_t_dgradvar)[_qp][pvar] * _grad_phi[_j][_qp]);
   return _test[_i][_qp] * (conduction_term_prime + advective_term_prime) * _multiplier;
 }

◆ mobility()

Real PorousFlowOutflowBC::mobility ( unsigned ph ) const

private

Mobility contribution to the outflowBC.

Definition at line 289 of file PorousFlowOutflowBC.C.

Referenced by computeQpResidual(), and jac().

 {
   return (_multiply_by_density ? (*_fluid_density_node)[_i][ph] : 1.0) *
          (_include_relperm ? (*_relative_permeability)[_i][ph] : 1.0) / _fluid_viscosity[_i][ph];
 }

◆ prefactor()

Real PorousFlowOutflowBC::prefactor ( unsigned ph ) const

private

Either mass_fraction or enthalpy, depending on _flux_type.

Definition at line 296 of file PorousFlowOutflowBC.C.

Referenced by computeQpResidual(), and jac().

 {
   return (_flux_type == FluxTypeChoiceEnum::FLUID ? (*_mass_fractions)[_i][ph][_sp]
                                                   : (*_enthalpy)[_i][ph]);
 }

◆ validParams()

InputParameters PorousFlowOutflowBC::validParams ( )

static

Definition at line 19 of file PorousFlowOutflowBC.C.

 {
   InputParameters params = IntegratedBC::validParams();
   params.addRequiredParam<UserObjectName>(
       "PorousFlowDictator", "The UserObject that holds the list of PorousFlow variable names");
   params.addRequiredParam<RealVectorValue>("gravity",
                                            "Gravitational acceleration vector downwards (m/s^2)");
   MooseEnum flux_type_enum("fluid heat", "fluid");
   params.addParam<MooseEnum>(
       "flux_type",
       flux_type_enum,
       "The type of boundary condition to apply.  'fluid' means this boundary condition will allow "
       "a fluid component to flow freely from the boundary.  'heat' means this boundary condition "
       "will allow heat energy to flow freely from the boundary");
   params.addParam<unsigned int>(
       "mass_fraction_component",
       0,
       "The index corresponding to a fluid "
       "component.  If supplied, the residual contribution will be "
       "multiplied by the mass fraction, corresponding to allowing the "
       "given mass fraction to flow freely from the boundary.  This is ignored if flux_type = heat");
   params.addParam<bool>("multiply_by_density",
                         true,
                         "If true, this BC represents mass flux.  If false, it represents volume "
                         "flux.  User input of this flag is ignored if flux_type = heat as "
                         "multiply_by_density should always be true in that case");
   params.addParam<bool>(
       "include_relperm",
       true,
       "If true, the Darcy flux will include the relative permeability.  If false, the relative "
       "permeability will not be used, which must only be used for fully-saturated situations "
       "where there is no notion of relative permeability");
   params.addParam<Real>(
       "multiplier",
       1.0,
       "Multiply the flux by this number.  This is mainly used for testing purposes");
   params.addParamNamesToGroup("multiplier", "Advanced");
   params.addClassDescription(
       "Applies an 'outflow' boundary condition, which allows fluid components or heat energy to "
       "flow freely out of the boundary as if it weren't there.  This is fully upwinded");
   return params;
 }

Member Data Documentation

◆ _denthalpy_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowOutflowBC::_denthalpy_dvar

protected

d(enthalpy of each phase)/d(PorousFlow variable)

Definition at line 127 of file PorousFlowOutflowBC.h.

◆ _dfluid_density_node_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowOutflowBC::_dfluid_density_node_dvar

protected

d(Fluid density for each phase (at the node))/d(PorousFlow variable)

Definition at line 109 of file PorousFlowOutflowBC.h.

◆ _dfluid_density_qp_dvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowOutflowBC::_dfluid_density_qp_dvar

protected

Derivative of the fluid density for each phase wrt PorousFlow variables (at the qp)

Definition at line 70 of file PorousFlowOutflowBC.h.

Referenced by jac().

◆ _dfluid_viscosity_dvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowOutflowBC::_dfluid_viscosity_dvar

protected

Derivative of the fluid viscosity for each phase wrt PorousFlow variables.

Definition at line 85 of file PorousFlowOutflowBC.h.

Referenced by jac().

◆ _dgrad_p_dgrad_var

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowOutflowBC::_dgrad_p_dgrad_var

protected

Derivative of Grad porepressure in each phase wrt grad(PorousFlow variables)

Definition at line 61 of file PorousFlowOutflowBC.h.

Referenced by jac().

◆ _dgrad_p_dvar

const MaterialProperty<std::vector<std::vector<RealGradient> > >& PorousFlowOutflowBC::_dgrad_p_dvar

protected

Derivative of Grad porepressure in each phase wrt PorousFlow variables.

Definition at line 64 of file PorousFlowOutflowBC.h.

Referenced by jac().

◆ _dgrad_t_dgradvar

const MaterialProperty<std::vector<Real> >* const PorousFlowOutflowBC::_dgrad_t_dgradvar

protected

d(gradT)/d(grad PorousFlow variable)

Definition at line 142 of file PorousFlowOutflowBC.h.

◆ _dgrad_t_dvar

const MaterialProperty<std::vector<RealGradient> >* const PorousFlowOutflowBC::_dgrad_t_dvar

protected

d(gradT)/d(PorousFlow variable)

Definition at line 139 of file PorousFlowOutflowBC.h.

◆ _dictator

const PorousFlowDictator& PorousFlowOutflowBC::_dictator

protected

PorousFlowDictator UserObject.

Definition at line 31 of file PorousFlowOutflowBC.h.

Referenced by jac(), and PorousFlowOutflowBC().

◆ _dmass_fractions_dvar

const MaterialProperty<std::vector<std::vector<std::vector<Real> > > >* const PorousFlowOutflowBC::_dmass_fractions_dvar

protected

d(Mass fraction of each component in each phase)/d(PorousFlow variable)

Definition at line 121 of file PorousFlowOutflowBC.h.

◆ _dpermeability_dgradvar

const MaterialProperty<std::vector<std::vector<RealTensorValue> > >& PorousFlowOutflowBC::_dpermeability_dgradvar

protected

d(permeabiity)/d(grad(PorousFlow variable))

Definition at line 79 of file PorousFlowOutflowBC.h.

Referenced by jac().

◆ _dpermeability_dvar

const MaterialProperty<std::vector<RealTensorValue> >& PorousFlowOutflowBC::_dpermeability_dvar

protected

d(permeabiity)/d(PorousFlow variable)

Definition at line 76 of file PorousFlowOutflowBC.h.

Referenced by jac().

◆ _drelative_permeability_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowOutflowBC::_drelative_permeability_dvar

protected

d(Relative permeability of each phase)/d(PorousFlow variable)

Definition at line 115 of file PorousFlowOutflowBC.h.

◆ _dthermal_conductivity_dvar

const MaterialProperty<std::vector<RealTensorValue> >* const PorousFlowOutflowBC::_dthermal_conductivity_dvar

protected

d(Thermal_Conductivity)/d(PorousFlow variable)

Definition at line 133 of file PorousFlowOutflowBC.h.

◆ _enthalpy

const MaterialProperty<std::vector<Real> >* const PorousFlowOutflowBC::_enthalpy

protected

Enthalpy of each phase.

Definition at line 124 of file PorousFlowOutflowBC.h.

Referenced by prefactor().

◆ _fluid_density_node

const MaterialProperty<std::vector<Real> >* const PorousFlowOutflowBC::_fluid_density_node

protected

Fluid density for each phase (at the node)

Definition at line 106 of file PorousFlowOutflowBC.h.

Referenced by mobility().

◆ _fluid_density_qp

const MaterialProperty<std::vector<Real> >& PorousFlowOutflowBC::_fluid_density_qp

protected

Fluid density for each phase (at the qp)

Definition at line 67 of file PorousFlowOutflowBC.h.

Referenced by darcy(), and jac().

◆ _fluid_viscosity

const MaterialProperty<std::vector<Real> >& PorousFlowOutflowBC::_fluid_viscosity

protected

Viscosity of each phase.

Definition at line 82 of file PorousFlowOutflowBC.h.

Referenced by jac(), and mobility().

◆ _flux_type

enum PorousFlowOutflowBC::FluxTypeChoiceEnum PorousFlowOutflowBC::_flux_type

protected

Referenced by computeQpResidual(), jac(), PorousFlowOutflowBC(), and prefactor().

◆ _grad_p

const MaterialProperty<std::vector<RealGradient> >& PorousFlowOutflowBC::_grad_p

protected

Gradient of the pore pressure in each phase.

Definition at line 58 of file PorousFlowOutflowBC.h.

Referenced by darcy(), and jac().

◆ _grad_t

const MaterialProperty<RealGradient>* const PorousFlowOutflowBC::_grad_t

protected

grad(temperature)

Definition at line 136 of file PorousFlowOutflowBC.h.

◆ _gravity

const RealVectorValue PorousFlowOutflowBC::_gravity

protected

Gravitational acceleration.

Definition at line 52 of file PorousFlowOutflowBC.h.

Referenced by darcy(), and jac().

◆ _has_density

const bool PorousFlowOutflowBC::_has_density

protected

Whether there is a fluid_phase_density_nodal Material.

Definition at line 88 of file PorousFlowOutflowBC.h.

Referenced by PorousFlowOutflowBC().

◆ _has_enthalpy

const bool PorousFlowOutflowBC::_has_enthalpy

protected

Whether there is an enthalpy Material.

Definition at line 97 of file PorousFlowOutflowBC.h.

Referenced by PorousFlowOutflowBC().

◆ _has_mass_fraction

const bool PorousFlowOutflowBC::_has_mass_fraction

protected

Whether there is a mass_frac_nodal Material.

Definition at line 91 of file PorousFlowOutflowBC.h.

Referenced by PorousFlowOutflowBC().

◆ _has_relperm

const bool PorousFlowOutflowBC::_has_relperm

protected

Whether there is a relative_permeability_nodal Material.

Definition at line 94 of file PorousFlowOutflowBC.h.

Referenced by PorousFlowOutflowBC().

◆ _has_t

const bool PorousFlowOutflowBC::_has_t

protected

Whether there is a grad_temp Material.

Definition at line 103 of file PorousFlowOutflowBC.h.

Referenced by PorousFlowOutflowBC().

◆ _has_thermal_conductivity

const bool PorousFlowOutflowBC::_has_thermal_conductivity

protected

Whether there is a thermal_conductivity_qp Material.

Definition at line 100 of file PorousFlowOutflowBC.h.

Referenced by PorousFlowOutflowBC().

◆ _include_relperm

const bool PorousFlowOutflowBC::_include_relperm

protected

Whether to multiply the Darcy flux by the relative permeability.

Definition at line 49 of file PorousFlowOutflowBC.h.

Referenced by jac(), mobility(), and PorousFlowOutflowBC().

◆ _mass_fractions

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowOutflowBC::_mass_fractions

protected

Mass fraction of each component in each phase.

Definition at line 118 of file PorousFlowOutflowBC.h.

Referenced by prefactor().

◆ _multiplier

const Real PorousFlowOutflowBC::_multiplier

protected

Multiply the flux by this quantity. This is mainly used for testing purposes, for instance, testing the Jacobian, and should ordinarily set to its default value of 1.0.

Definition at line 55 of file PorousFlowOutflowBC.h.

Referenced by computeQpResidual(), and jac().

◆ _multiply_by_density

const bool PorousFlowOutflowBC::_multiply_by_density

protected

Whether to multiply the Darcy flux by the fluid density. This is automatically set to true if _flux_type==HEAT.

Definition at line 46 of file PorousFlowOutflowBC.h.

Referenced by jac(), mobility(), and PorousFlowOutflowBC().

◆ _num_phases

const unsigned PorousFlowOutflowBC::_num_phases

protected

Number of phases in the simulation.

Definition at line 34 of file PorousFlowOutflowBC.h.

Referenced by computeQpResidual(), and jac().

◆ _perm_derivs

const bool PorousFlowOutflowBC::_perm_derivs

protected

Flag indicating whether to include derivatives of the permeability in the Jacobian.

Definition at line 37 of file PorousFlowOutflowBC.h.

Referenced by jac().

◆ _permeability

const MaterialProperty<RealTensorValue>& PorousFlowOutflowBC::_permeability

protected

Permeability of porous material.

Definition at line 73 of file PorousFlowOutflowBC.h.

Referenced by darcy(), and jac().

◆ _relative_permeability

const MaterialProperty<std::vector<Real> >* const PorousFlowOutflowBC::_relative_permeability

protected

Relative permeability of each phase.

Definition at line 112 of file PorousFlowOutflowBC.h.

◆ _sp

const unsigned int PorousFlowOutflowBC::_sp

protected

The fluid component number (only used if _flux_type==FLUID))

Definition at line 43 of file PorousFlowOutflowBC.h.

Referenced by jac(), PorousFlowOutflowBC(), and prefactor().

◆ _thermal_conductivity

const MaterialProperty<RealTensorValue>* const PorousFlowOutflowBC::_thermal_conductivity

protected

Thermal_Conductivity of porous material.

Definition at line 130 of file PorousFlowOutflowBC.h.

Referenced by jac().

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

porous_flow/include/bcs/PorousFlowOutflowBC.h
porous_flow/src/bcs/PorousFlowOutflowBC.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ FluxTypeChoiceEnum

Constructor & Destructor Documentation

◆ PorousFlowOutflowBC()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ darcy()

◆ jac()

◆ mobility()

◆ prefactor()

◆ validParams()

Member Data Documentation

◆ _denthalpy_dvar

◆ _dfluid_density_node_dvar

◆ _dfluid_density_qp_dvar

◆ _dfluid_viscosity_dvar

◆ _dgrad_p_dgrad_var

◆ _dgrad_p_dvar

◆ _dgrad_t_dgradvar

◆ _dgrad_t_dvar

◆ _dictator

◆ _dmass_fractions_dvar

◆ _dpermeability_dgradvar

◆ _dpermeability_dvar

◆ _drelative_permeability_dvar

◆ _dthermal_conductivity_dvar

◆ _enthalpy

◆ _fluid_density_node

◆ _fluid_density_qp

◆ _fluid_viscosity

◆ _flux_type

◆ _grad_p

◆ _grad_t

◆ _gravity

◆ _has_density

◆ _has_enthalpy

◆ _has_mass_fraction

◆ _has_relperm

◆ _has_t

◆ _has_thermal_conductivity

◆ _include_relperm

◆ _mass_fractions

◆ _multiplier

◆ _multiply_by_density

◆ _num_phases

◆ _perm_derivs

◆ _permeability

◆ _relative_permeability

◆ _sp

◆ _thermal_conductivity