Surrogate BC object for setting up enthalphy injection BC. More...

#include <PorousFlowSinkBC.h>

Inheritance diagram for PorousFlowSinkBC:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PorousFlowSinkBC (const InputParameters &parameters)

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

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

Public Attributes
const ConsoleStream	_console

Protected Attributes
const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const Parallel::Communicator &	_communicator

Detailed Description

Surrogate BC object for setting up enthalphy injection BC.

It specifies paramteres that users have to provide like in a normal object, but does not do anything. PorousFlowAddBCAction sets up the concrete objects that will model this type of BC.

Definition at line 21 of file PorousFlowSinkBC.h.

Constructor & Destructor Documentation

◆ PorousFlowSinkBC()

PorousFlowSinkBC::PorousFlowSinkBC ( const InputParameters & parameters )

Definition at line 52 of file PorousFlowSinkBC.C.

52 : MooseObject(parameters) {}

MooseObject::MooseObject

MooseObject(const InputParameters &parameters)

MooseObject::parameters

const InputParameters & parameters() const

Member Function Documentation

◆ validParams()

InputParameters PorousFlowSinkBC::validParams ( )

static

Definition at line 33 of file PorousFlowSinkBC.C.

 {
   InputParameters params = MooseObject::validParams();
   params += PorousFlowSinkBC::validParamsCommon();
   params.addRequiredParam<std::vector<BoundaryName>>(
       "boundary", "The list of boundary IDs from the mesh where this boundary condition applies");
   params.addRequiredParam<UserObjectName>(
       "PorousFlowDictator", "The UserObject that holds the list of PorousFlow variable names");
 
   params.addClassDescription(
       "BC corresponding to hot/cold fluid injection. This BC is only valid for "
       "single-phase, non-isothermal simulations using (P, T) variables. This BC adds fluid mass "
       "and heat energy. It is only meaningful if flux_function <= 0");
 
   params.registerBase("PorousFlowSinkBC");
 
   return params;
 }

◆ validParamsCommon()

InputParameters PorousFlowSinkBC::validParamsCommon ( )

static

Definition at line 15 of file PorousFlowSinkBC.C.

Referenced by PorousFlowEnthalpySink::validParams(), and validParams().

 {
   InputParameters params = emptyInputParameters();
   params.addCoupledVar("porepressure_var", "Name of the porepressure variable");
   params.addParam<unsigned int>("fluid_phase",
                                 "Evaluate enthalpy at the pressure of this fluid phase.");
   params.addRequiredParam<UserObjectName>("fp", "The name of the user object for fluid properties");
   params.addRequiredParam<Real>("T_in", "Specified inlet temperature (measured in K)");
   params.addRequiredParam<FunctionName>(
       "flux_function",
       "The flux.  The flux is OUT of the medium: hence positive values of "
       "this function means this BC will act as a SINK, while negative values "
       "indicate this flux will be a SOURCE. However, this BC only makes physical sense if "
       "flux_function <= 0.  This function is measured in kg.m^-2.s^-1.");
   return params;
 }

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

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

Public Types

Public Member Functions

Static Public Member Functions