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

Computes a property from a TwoPhaseNCGPartialPressureFluidProperties object. More...

#include <TwoPhaseNCGPartialPressureFunction.h>

Inheritance diagram for TwoPhaseNCGPartialPressureFunction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 
typedef FunctorBase< Real > FunctorType
 
typedef Real ValueType
 
typedef typename FunctorReturnType< Real, FunctorEvaluationKind::Gradient >::type GradientType
 
typedef ValueType DotType
 

Public Member Functions

 TwoPhaseNCGPartialPressureFunction (const InputParameters &parameters)
 
virtual void initialSetup () override
 
virtual Real value (Real t, const Point &p) const override
 
virtual Real value (Real t, const Point &p) const
 
virtual ADReal value (const ADReal &t, const ADPoint &p) const
 
ChainedReal value (const ChainedReal &t) const
 
auto value (const U &t) const
 
auto value (const U &t, const U &x, const U &y=0, const U &z=0) const
 
ChainedReal value (const ChainedReal &t) const
 
auto value (const U &t) const
 
auto value (const U &t, const U &x, const U &y=0, const U &z=0) const
 
virtual ADReal value (const ADReal &t, const ADPoint &p) const
 
ChainedReal value (const ChainedReal &t) const
 
auto value (const U &t) const
 
auto value (const U &t, const U &x, const U &y=0, const U &z=0) const
 
virtual RealVectorValue vectorValue (Real t, const Point &p) const
 
virtual RealVectorValue curl (Real t, const Point &p) const
 
virtual Real div (Real t, const Point &p) const
 
virtual RealGradient gradient (Real t, const Point &p) const
 
GradientType gradient (const ElemArg &elem, const StateArg &state) const
 
GradientType gradient (const FaceArg &face, const StateArg &state) const
 
GradientType gradient (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradient (const NodeArg &node, const StateArg &state) const
 
GradientType gradient (const ElemArg &elem, const StateArg &state) const
 
GradientType gradient (const FaceArg &face, const StateArg &state) const
 
GradientType gradient (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradient (const NodeArg &node, const StateArg &state) const
 
GradientType gradient (const ElemArg &elem, const StateArg &state) const
 
GradientType gradient (const FaceArg &face, const StateArg &state) const
 
GradientType gradient (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradient (const NodeArg &node, const StateArg &state) const
 
virtual Real timeDerivative (Real t, const Point &p) const
 
auto timeDerivative (const U &t) const
 
auto timeDerivative (const U &t, const U &x, const U &y=0, const U &z=0) const
 
auto timeDerivative (const U &t) const
 
auto timeDerivative (const U &t, const U &x, const U &y=0, const U &z=0) const
 
virtual Real integral () const
 
virtual Real average () const
 
virtual Real timeIntegral (Real t1, Real t2, const Point &p) const
 
void timestepSetup () override
 
void residualSetup () override final
 
void jacobianSetup () override final
 
void customSetup (const ExecFlagType &exec_type) override final
 
bool hasBlocks (SubdomainID) const override
 
bool supportsFaceArg () const override final
 
bool supportsElemSideQpArg () const override final
 
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 subdomainSetup ()
 
const ExecFlagEnum & getExecuteOnEnum () 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
 
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
 
virtual void meshChanged ()
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
FunctorReturnType< Real, FET >::type genericEvaluate (const Space &r, const State &state) const
 
const MooseFunctorName & functorName () const
 
void setCacheClearanceSchedule (const std::set< ExecFlagType > &clearance_schedule)
 
virtual bool isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const
 
bool isInternalFace (const FaceInfo &) const
 
virtual bool isConstant () const
 
virtual bool hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override
 
void checkFace (const Moose::FaceArg &face) 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 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
 
ValueType operator() (const ElemArg &elem, const StateArg &state) const
 
ValueType operator() (const FaceArg &face, const StateArg &state) const
 
ValueType operator() (const ElemQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemSideQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemPointArg &elem_point, const StateArg &state) const
 
ValueType operator() (const NodeArg &node, const StateArg &state) const
 
ValueType operator() (const ElemArg &elem, const StateArg &state) const
 
ValueType operator() (const FaceArg &face, const StateArg &state) const
 
ValueType operator() (const ElemQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemSideQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemPointArg &elem_point, const StateArg &state) const
 
ValueType operator() (const NodeArg &node, const StateArg &state) const
 
ValueType operator() (const ElemArg &elem, const StateArg &state) const
 
ValueType operator() (const FaceArg &face, const StateArg &state) const
 
ValueType operator() (const ElemQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemSideQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemPointArg &elem_point, const StateArg &state) const
 
ValueType operator() (const NodeArg &node, const StateArg &state) const
 
DotType dot (const ElemArg &elem, const StateArg &state) const
 
DotType dot (const FaceArg &face, const StateArg &state) const
 
DotType dot (const ElemQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemSideQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemPointArg &elem_point, const StateArg &state) const
 
DotType dot (const NodeArg &node, const StateArg &state) const
 
DotType dot (const ElemArg &elem, const StateArg &state) const
 
DotType dot (const FaceArg &face, const StateArg &state) const
 
DotType dot (const ElemQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemSideQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemPointArg &elem_point, const StateArg &state) const
 
DotType dot (const NodeArg &node, const StateArg &state) const
 
DotType dot (const ElemArg &elem, const StateArg &state) const
 
DotType dot (const FaceArg &face, const StateArg &state) const
 
DotType dot (const ElemQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemSideQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemPointArg &elem_point, const StateArg &state) const
 
DotType dot (const NodeArg &node, const StateArg &state) const
 
GradientType gradDot (const ElemArg &elem, const StateArg &state) const
 
GradientType gradDot (const FaceArg &face, const StateArg &state) const
 
GradientType gradDot (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradDot (const NodeArg &node, const StateArg &state) const
 
GradientType gradDot (const ElemArg &elem, const StateArg &state) const
 
GradientType gradDot (const FaceArg &face, const StateArg &state) const
 
GradientType gradDot (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradDot (const NodeArg &node, const StateArg &state) const
 
GradientType gradDot (const ElemArg &elem, const StateArg &state) const
 
GradientType gradDot (const FaceArg &face, const StateArg &state) const
 
GradientType gradDot (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradDot (const NodeArg &node, const StateArg &state) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () 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
 

Static Public Member Functions

static InputParameters validParams ()
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static const std::map< std::string, unsigned int > _n_expected_args
 Number of expected arguments for each property call. More...
 

Protected Member Functions

virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) 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
 
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 GradientType evaluateGradDot (const ElemArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemPointArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const NodeArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemPointArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const NodeArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemPointArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const NodeArg &, const StateArg &) const
 
virtual ValueType evaluate (const ElemArg &elem, const StateArg &state) const =0
 
virtual ValueType evaluate (const FaceArg &face, const StateArg &state) const =0
 
virtual ValueType evaluate (const ElemQpArg &qp, const StateArg &state) const =0
 
virtual ValueType evaluate (const ElemSideQpArg &side_qp, const StateArg &state) const =0
 
virtual ValueType evaluate (const ElemPointArg &elem_point, const StateArg &state) const =0
 
virtual ValueType evaluate (const NodeArg &node, const StateArg &state) const =0
 
virtual GradientType evaluateGradient (const ElemArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const ElemPointArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const NodeArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemArg &, const StateArg &) const
 
virtual DotType evaluateDot (const FaceArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemQpArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemSideQpArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemPointArg &, const StateArg &) const
 
virtual DotType evaluateDot (const NodeArg &, const StateArg &) const
 

Protected Attributes

const TwoPhaseNCGPartialPressureFluidProperties * _fp
 Fluid properties object. More...
 
const MooseEnum & _property_call
 Property call. More...
 
const Function & _arg1_fn
 Argument 1 function. More...
 
const Function & _arg2_fn
 Argument 2 function. More...
 
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
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const Parallel::Communicator & _communicator
 

Detailed Description

Computes a property from a TwoPhaseNCGPartialPressureFluidProperties object.

Definition at line 20 of file TwoPhaseNCGPartialPressureFunction.h.

Constructor & Destructor Documentation

◆ TwoPhaseNCGPartialPressureFunction()

TwoPhaseNCGPartialPressureFunction::TwoPhaseNCGPartialPressureFunction ( const InputParameters &  parameters)

Definition at line 38 of file TwoPhaseNCGPartialPressureFunction.C.

40  : Function(parameters),
41  FunctionInterface(this),
42  _property_call(getParam<MooseEnum>("property_call")),
43  _arg1_fn(getFunction("arg1")),
44  _arg2_fn(getFunction("arg2"))
45 {
46  // Check that the provided arguments matches the expected number
47  if (_n_expected_args.find(_property_call) != _n_expected_args.end())
48  {
49  bool args_are_valid = true;
50  const unsigned int n_arg_params = 2;
51  const auto n_expected_args = _n_expected_args.at(_property_call);
52  std::vector<std::string> expected_args, provided_args;
53  for (unsigned int i = 0; i < n_arg_params; i++)
54  {
55  const std::string arg_param = "arg" + std::to_string(i + 1);
56  const std::string arg_str = "'" + arg_param + "'";
57 
58  const bool arg_is_expected = i + 1 <= n_expected_args;
59  if (arg_is_expected)
60  expected_args.push_back(arg_str);
61 
62  if (isParamSetByUser(arg_param))
63  {
64  provided_args.push_back(arg_str);
65  if (!arg_is_expected)
66  args_are_valid = false;
67  }
68  else
69  {
70  if (arg_is_expected)
71  args_are_valid = false;
72  }
73  }
74 
75  if (!args_are_valid)
76  mooseError("The property call '",
77  _property_call,
78  "' expects the parameter(s) {",
79  MooseUtils::join(expected_args, ", "),
80  "} to be provided, but the provided argument(s) were {",
81  MooseUtils::join(provided_args, ", "),
82  "}.");
83  }
84  else
85  mooseError("Property call in MooseEnum but not _n_expected_args.");
86 }
MooseUtils::join
std::string join(Iterator begin, Iterator end, const std::string &delimiter)
FunctionInterface::FunctionInterface
FunctionInterface(const MooseObject *moose_object)
FunctionInterface::getFunction
const Function & getFunction(const std::string &name) const
TwoPhaseNCGPartialPressureFunction::_n_expected_args
static const std::map< std::string, unsigned int > _n_expected_args
Number of expected arguments for each property call.
Definition: TwoPhaseNCGPartialPressureFunction.h:24
Function::Function
Function(const InputParameters &parameters)
TwoPhaseNCGPartialPressureFunction::_arg1_fn
const Function & _arg1_fn
Argument 1 function.
Definition: TwoPhaseNCGPartialPressureFunction.h:40
Function::isParamSetByUser
bool isParamSetByUser(const std::string &nm) const
TwoPhaseNCGPartialPressureFunction::_arg2_fn
const Function & _arg2_fn
Argument 2 function.
Definition: TwoPhaseNCGPartialPressureFunction.h:42
Function::mooseError
void mooseError(Args &&... args) const
Function::parameters
const InputParameters & parameters() const

Member Function Documentation

◆ initialSetup()

void TwoPhaseNCGPartialPressureFunction::initialSetup ( )
overridevirtual

Reimplemented from Function.

Definition at line 89 of file TwoPhaseNCGPartialPressureFunction.C.

90 {
91  _fp = &getUserObject<TwoPhaseNCGPartialPressureFluidProperties>("fluid_properties");
92 }
TwoPhaseNCGPartialPressureFunction::_fp
const TwoPhaseNCGPartialPressureFluidProperties * _fp
Fluid properties object.
Definition: TwoPhaseNCGPartialPressureFunction.h:36

◆ validParams()

InputParameters TwoPhaseNCGPartialPressureFunction::validParams ( )
static

Definition at line 20 of file TwoPhaseNCGPartialPressureFunction.C.

21 {
22  InputParameters params = Function::validParams();
23  params.addClassDescription(
24  "Computes a property from a TwoPhaseNCGPartialPressureFluidProperties object.");
25 
26  params.addRequiredParam<UserObjectName>("fluid_properties",
27  "The TwoPhaseNCGPartialPressureFluidProperties object");
28 
29  MooseEnum property_call("p_sat x_sat_ncg_from_p_T");
30  params.addRequiredParam<MooseEnum>("property_call", property_call, "Which function to call");
31 
32  params.addParam<FunctionName>("arg1", 0, "The first argument for the property call, if any");
33  params.addParam<FunctionName>("arg2", 0, "The second argument for the property call, if any");
34 
35  return params;
36 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
Function::validParams
static InputParameters validParams()

◆ value() [1/9]

auto Function::value

◆ value() [2/9]

ChainedReal Function::value

◆ value() [3/9]

virtual ADReal Function::value

◆ value() [4/9]

auto Function::value

◆ value() [5/9]

ChainedReal Function::value

◆ value() [6/9]

auto Function::value

◆ value() [7/9]

auto Function::value

◆ value() [8/9]

virtual Real Function::value

◆ value() [9/9]

Real TwoPhaseNCGPartialPressureFunction::value ( Real  t,
const Point &  p 
) const
overridevirtual

Reimplemented from Function.

Definition at line 95 of file TwoPhaseNCGPartialPressureFunction.C.

96 {
97  const Real arg1 = _arg1_fn.value(t, point);
98  const Real arg2 = _arg2_fn.value(t, point);
99 
100  if (_property_call == "p_sat")
101  return _fp->p_sat(arg1);
102  else if (_property_call == "x_sat_ncg_from_p_T")
103  return _fp->x_sat_ncg_from_p_T(arg1, arg2);
104  else
105  mooseError("Unimplemented property call.");
106 }
TwoPhaseNCGPartialPressureFunction::_fp
const TwoPhaseNCGPartialPressureFluidProperties * _fp
Fluid properties object.
Definition: TwoPhaseNCGPartialPressureFunction.h:36
TwoPhaseNCGPartialPressureFluidProperties::x_sat_ncg_from_p_T
Real x_sat_ncg_from_p_T(Real p, Real T) const
Computes the NCG mass fraction with the CG saturated at the given temperature.
Definition: TwoPhaseNCGPartialPressureFluidProperties.C:53
TwoPhaseNCGFluidProperties::p_sat
virtual Real p_sat(Real T) const override
Computes the saturation pressure at a temperature.
Definition: TwoPhaseNCGFluidProperties.h:60
TwoPhaseNCGPartialPressureFunction::_arg1_fn
const Function & _arg1_fn
Argument 1 function.
Definition: TwoPhaseNCGPartialPressureFunction.h:40
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
TwoPhaseNCGPartialPressureFunction::_arg2_fn
const Function & _arg2_fn
Argument 2 function.
Definition: TwoPhaseNCGPartialPressureFunction.h:42
Function::mooseError
void mooseError(Args &&... args) const
Function::value
virtual Real value(Real t, const Point &p) const

Member Data Documentation

◆ _arg1_fn

const Function& TwoPhaseNCGPartialPressureFunction::_arg1_fn
protected

Argument 1 function.

Definition at line 40 of file TwoPhaseNCGPartialPressureFunction.h.

Referenced by value().

◆ _arg2_fn

const Function& TwoPhaseNCGPartialPressureFunction::_arg2_fn
protected

Argument 2 function.

Definition at line 42 of file TwoPhaseNCGPartialPressureFunction.h.

Referenced by value().

◆ _fp

const TwoPhaseNCGPartialPressureFluidProperties* TwoPhaseNCGPartialPressureFunction::_fp
protected

Fluid properties object.

Definition at line 36 of file TwoPhaseNCGPartialPressureFunction.h.

Referenced by initialSetup(), and value().

◆ _n_expected_args

const std::map< std::string, unsigned int > TwoPhaseNCGPartialPressureFunction::_n_expected_args
static
Initial value:
{
{"p_sat", 1}, {"x_sat_ncg_from_p_T", 2}}

Number of expected arguments for each property call.

Definition at line 24 of file TwoPhaseNCGPartialPressureFunction.h.

Referenced by TwoPhaseNCGPartialPressureFunction().

◆ _property_call

const MooseEnum& TwoPhaseNCGPartialPressureFunction::_property_call
protected

Property call.

Definition at line 38 of file TwoPhaseNCGPartialPressureFunction.h.

Referenced by TwoPhaseNCGPartialPressureFunction(), and value().

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