Action that sets up BCs for porous flow module. More...

#include <PorousFlowAddBCAction.h>

Inheritance diagram for PorousFlowAddBCAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PorousFlowAddBCAction (const InputParameters &parameters)

virtual void	act () override

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type) override

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

InputParameters &	getObjectParams ()

const InputParameters &	getObjectParams () const

const std::string &	getMooseObjectType () const

void	timedAct ()

MooseObjectName	uniqueActionName () const

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) 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

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
void	setupPorousFlowEnthalpySink ()
	Setup a BC corresponding to hot/cold fluid injection. More...

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

void	associateWithParameter (const std::string &param_name, InputParameters &params) const

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
std::string	_type

InputParameters	_moose_object_pars

std::string	_registered_identifier

std::string	_specific_task_name

std::set< std::string >	_all_tasks

ActionWarehouse &	_awh

const std::string &	_current_task

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem

PerfID	_act_timer

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Detailed Description

Action that sets up BCs for porous flow module.

Definition at line 17 of file PorousFlowAddBCAction.h.

Constructor & Destructor Documentation

◆ PorousFlowAddBCAction()

PorousFlowAddBCAction::PorousFlowAddBCAction ( const InputParameters & parameters )

Definition at line 24 of file PorousFlowAddBCAction.C.

   : MooseObjectAction(parameters)
 {
 }

Member Function Documentation

◆ act()

void PorousFlowAddBCAction::act ( )

overridevirtual

Implements MooseObjectAction.

Definition at line 30 of file PorousFlowAddBCAction.C.

 {
   if (_type == "PorousFlowSinkBC")
     setupPorousFlowEnthalpySink();
   // NOTE: no reason to catch unknown types here - MOOSE will catch that much earlier
 }

◆ setupPorousFlowEnthalpySink()

void PorousFlowAddBCAction::setupPorousFlowEnthalpySink ( )

protected

Setup a BC corresponding to hot/cold fluid injection.

Definition at line 38 of file PorousFlowAddBCAction.C.

Referenced by act().

 {
   std::string nm = name();
 
   THREAD_ID tid = 0;
   const InputParameters & obj_pars = getObjectParams();
 
   // check that we have 2 porous flow variables
   const PorousFlowDictator & dictator = _problem->getUserObject<PorousFlowDictator>(
       obj_pars.get<UserObjectName>("PorousFlowDictator"));
   if (dictator.numVariables() != 2)
     mooseError(name(),
                ": Number of porous flow variables in simulation is '",
                dictator.numVariables(),
                "', but this BC can be used only with pressure and temperature.");
 
   if (obj_pars.isParamValid("porepressure_var"))
   {
     const std::vector<VariableName> & pressure_param =
         obj_pars.get<std::vector<VariableName>>("porepressure_var");
     if (pressure_param.size() != 1)
       mooseError(name(), ": 'porepressure_var' parameter can currently take only a single value");
   }
   const std::vector<BoundaryName> & boundary = obj_pars.get<std::vector<BoundaryName>>("boundary");
   const UserObjectName & dictator_name = obj_pars.get<UserObjectName>("PorousFlowDictator");
   const FunctionName & flux_fn_name = obj_pars.get<FunctionName>("flux_function");
 
   const MooseVariableFEBase & p_m_var =
       _problem->getNonlinearSystemBase(/*nl_sys_num=*/0).getVariable(tid, 0);
   const MooseVariableFEBase & T_m_var =
       _problem->getNonlinearSystemBase(/*nl_sys_num=*/0).getVariable(tid, 1);
 
   bool has_fluid_phase = obj_pars.isParamValid("fluid_phase");
   {
     const std::string class_name = "PorousFlowSink";
     InputParameters pars = _factory.getValidParams(class_name);
     _app.builder().extractParams(_name, pars); // extract global params
     pars.set<NonlinearVariableName>("variable") = {p_m_var.name()};
     pars.set<std::vector<BoundaryName>>("boundary") = boundary;
     pars.set<UserObjectName>("PorousFlowDictator") = dictator_name;
     pars.set<bool>("use_mobility") = false;
     pars.set<bool>("use_relperm") = false;
     if (has_fluid_phase)
       pars.set<unsigned int>("fluid_phase") = obj_pars.get<unsigned int>("fluid_phase");
     else
       pars.set<std::vector<VariableName>>("porepressure_var") =
           obj_pars.get<std::vector<VariableName>>("porepressure_var");
     pars.set<FunctionName>("flux_function") = flux_fn_name;
     _problem->addBoundaryCondition(class_name, nm + "_p_bc", pars);
   }
   {
     const std::string class_name = "PorousFlowEnthalpySink";
     InputParameters pars = _factory.getValidParams(class_name);
     _app.builder().extractParams(_name, pars); // extract global params
     pars.set<NonlinearVariableName>("variable") = {T_m_var.name()};
     pars.set<std::vector<BoundaryName>>("boundary") = boundary;
     pars.set<Real>("T_in") = obj_pars.get<Real>("T_in");
     pars.set<UserObjectName>("fp") = obj_pars.get<UserObjectName>("fp");
     pars.set<UserObjectName>("PorousFlowDictator") = dictator_name;
     if (has_fluid_phase)
       pars.set<unsigned int>("fluid_phase") = obj_pars.get<unsigned int>("fluid_phase");
     else
       pars.set<std::vector<VariableName>>("porepressure_var") =
           obj_pars.get<std::vector<VariableName>>("porepressure_var");
     pars.set<FunctionName>("flux_function") = flux_fn_name;
     _problem->addBoundaryCondition(class_name, nm + "_T_bc", pars);
   }
 }

◆ validParams()

InputParameters PorousFlowAddBCAction::validParams ( )

static

Definition at line 17 of file PorousFlowAddBCAction.C.

 {
   InputParameters params = MooseObjectAction::validParams();
   params.addClassDescription("Action that allows adding BCs using proxy classes.");
   return params;
 }

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

porous_flow/include/actions/PorousFlowAddBCAction.h
porous_flow/src/actions/PorousFlowAddBCAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions