This holds maps between pressure_var or pressure_var, sat_var used in RichardsMaterial and kernels, etc, and the variable number used internally by MOOSE. More...

#include <RichardsVarNames.h>

Inheritance diagram for RichardsVarNames:

[legend]

Public Member Functions
	RichardsVarNames (const InputParameters &parameters)

void	initialize ()

void	execute ()

void	finalize ()

unsigned int	num_v () const
	the number of porepressure variables More...

unsigned int	richards_var_num (unsigned int moose_var_num) const
	the richards variable number More...

bool	not_richards_var (unsigned int moose_var_num) const
	returns true if moose_var_num is not a richards var More...

std::string	richards_names () const
	a space-separated string of richards variable names eg richards_names() = 'pwater pgas' More...

const VariableValue *	richards_vals (unsigned int richards_var_num) const
	a vector of pointers to VariableValues More...

const VariableValue *	richards_vals_old (unsigned int richards_var_num) const
	a vector of pointers to old VariableValues More...

const VariableGradient *	grad_var (unsigned int richards_var_num) const
	a vector of pointers to grad(Variable) More...

const VariableValue *	nodal_var (unsigned int richards_var_num) const
	The nodal variable values for the given richards_var_num To extract a the value of pressure variable "pvar", at node i, use (*RichardsVarNames.nodal_var(pvar))[i]. More...

const VariableValue *	nodal_var_old (unsigned int richards_var_num) const
	The old nodal variable values for the given richards_var_num. More...

std::string	var_types () const
	return the _var_types string More...

Protected Attributes
unsigned int	_num_v
	number of richards variables More...

MooseEnum	_var_types
	physical meaning of the variables. Eg 'pppp' means 'all variables are pressure variables' More...

std::vector< unsigned int >	_moose_var_num
	_moose_var_num[i] = the moose variable number corresponding to richards variable i More...

std::vector< unsigned int >	_ps_var_num
	_pressure_var_num[i] = the richards variable corresponding to moose variable i More...

std::vector< const VariableValue * >	_moose_var_value
	moose_var_value[i] = values of richards variable i More...

std::vector< const VariableValue * >	_moose_var_value_old
	moose_var_value_old[i] = old values of richards variable i More...

std::vector< const VariableValue * >	_moose_nodal_var_value
	moose_var_value[i] = values of richards variable i More...

std::vector< const VariableValue * >	_moose_nodal_var_value_old
	moose_var_value_old[i] = old values of richards variable i More...

std::vector< const VariableGradient * >	_moose_grad_var
	moose_grad_var[i] = gradient values of richards variable i More...

Detailed Description

This holds maps between pressure_var or pressure_var, sat_var used in RichardsMaterial and kernels, etc, and the variable number used internally by MOOSE.

Definition at line 25 of file RichardsVarNames.h.

Constructor & Destructor Documentation

◆ RichardsVarNames()

RichardsVarNames::RichardsVarNames ( const InputParameters & parameters )

Definition at line 38 of file RichardsVarNames.C.

   : GeneralUserObject(parameters),
     Coupleable(this, false),
     _num_v(coupledComponents("richards_vars")),
     _var_types(getParam<MooseEnum>("var_types"))
 {
   unsigned int max_moose_var_num_seen = 0;
  
   _moose_var_num.resize(_num_v);
   _moose_var_value.resize(_num_v);
   _moose_var_value_old.resize(_num_v);
   _moose_nodal_var_value.resize(_num_v);
   _moose_nodal_var_value_old.resize(_num_v);
   _moose_grad_var.resize(_num_v);
   for (unsigned int i = 0; i < _num_v; ++i)
   {
     _moose_var_num[i] = coupled("richards_vars", i);
     max_moose_var_num_seen =
         (max_moose_var_num_seen > _moose_var_num[i] ? max_moose_var_num_seen : _moose_var_num[i]);
     _moose_var_value[i] = &coupledValue("richards_vars", i); // coupledValue returns a reference (an
                                                              // alias) to a VariableValue, and the &
                                                              // turns it into a pointer
     _moose_var_value_old[i] = (_is_transient ? &coupledValueOld("richards_vars", i) : &_zero);
     _moose_nodal_var_value[i] = &coupledDofValues("richards_vars", i); // coupledDofValues returns
                                                                        // a reference (an alias) to
                                                                        // a VariableValue, and the
                                                                        // & turns it into a pointer
     _moose_nodal_var_value_old[i] =
         (_is_transient ? &coupledDofValuesOld("richards_vars", i) : &_zero);
     _moose_grad_var[i] = &coupledGradient("richards_vars", i);
   }
  
   _ps_var_num.resize(max_moose_var_num_seen + 1);
   for (unsigned int i = 0; i < max_moose_var_num_seen + 1; ++i)
     _ps_var_num[i] = _num_v; // NOTE: indicates that i is not a richards variable
   for (unsigned int i = 0; i < _num_v; ++i)
     _ps_var_num[_moose_var_num[i]] = i;
 }

Member Function Documentation

◆ execute()

void RichardsVarNames::execute ( )

Definition at line 83 of file RichardsVarNames.C.

84 {

85 }

◆ finalize()

void RichardsVarNames::finalize ( )

Definition at line 88 of file RichardsVarNames.C.

89 {

90 }

◆ grad_var()

const VariableGradient * RichardsVarNames::grad_var ( unsigned int richards_var_num ) const

a vector of pointers to grad(Variable)

Parameters

richards_var_num the richards variable number eg if richards_vars = 'pwater pgas', then (*grad_var(1))[qp] = grad(pgas) evaluated at quadpoint qp Also grad_var(i) = &coupledGradient

Definition at line 130 of file RichardsVarNames.C.

 {
   return _moose_grad_var[richards_var_num];
 }

Referenced by RichardsMaterial::computePandSeff().

◆ initialize()

void RichardsVarNames::initialize ( )

Definition at line 78 of file RichardsVarNames.C.

79 {

80 }

◆ nodal_var()

const VariableValue * RichardsVarNames::nodal_var ( unsigned int richards_var_num ) const

The nodal variable values for the given richards_var_num To extract a the value of pressure variable "pvar", at node i, use (*RichardsVarNames.nodal_var(pvar))[i].

Parameters

richards_var_num the richards variable number

Definition at line 142 of file RichardsVarNames.C.

 {
   return _moose_nodal_var_value[richards_var_num];
 }

Referenced by RichardsBorehole::RichardsBorehole(), RichardsFullyUpwindFlux::RichardsFullyUpwindFlux(), RichardsLumpedMassChange::RichardsLumpedMassChange(), and RichardsPiecewiseLinearSink::RichardsPiecewiseLinearSink().

◆ nodal_var_old()

const VariableValue * RichardsVarNames::nodal_var_old ( unsigned int richards_var_num ) const

The old nodal variable values for the given richards_var_num.

Parameters

richards_var_num the richards variable number

Definition at line 148 of file RichardsVarNames.C.

 {
   return _moose_nodal_var_value_old[richards_var_num];
 }

Referenced by RichardsLumpedMassChange::RichardsLumpedMassChange().

◆ not_richards_var()

bool RichardsVarNames::not_richards_var ( unsigned int moose_var_num ) const

returns true if moose_var_num is not a richards var

Parameters

moose_var_num the MOOSE variable number eg if richards_vars = 'pwater pgas', and the variables in the simulation are 'temperature pwater pgas displacement' then not_pressure_var(0) = true, no_pressure_var(1) = false

Definition at line 109 of file RichardsVarNames.C.

 {
   if (moose_var_num >= _ps_var_num.size() || _ps_var_num[moose_var_num] == _num_v)
     return true;
   return false;
 }

Referenced by RichardsFlux::computeQpOffDiagJacobian(), RichardsMassChange::computeQpOffDiagJacobian(), RichardsHalfGaussianSink::computeQpOffDiagJacobian(), RichardsLumpedMassChange::computeQpOffDiagJacobian(), RichardsPolyLineSink::computeQpOffDiagJacobian(), RichardsPiecewiseLinearSink::computeQpOffDiagJacobian(), RichardsBorehole::computeQpOffDiagJacobian(), and RichardsFullyUpwindFlux::upwind().

◆ num_v()

unsigned int RichardsVarNames::num_v ( ) const

the number of porepressure variables

Definition at line 93 of file RichardsVarNames.C.

 {
   return _num_v;
 }

◆ richards_names()

std::string RichardsVarNames::richards_names ( ) const

a space-separated string of richards variable names eg richards_names() = 'pwater pgas'

◆ richards_vals()

const VariableValue * RichardsVarNames::richards_vals ( unsigned int richards_var_num ) const

a vector of pointers to VariableValues

Parameters

richards_var_num the pressure variable number eg if richards_vars = 'pwater pgas', then (*richards_vals(1))[qp] = pgas evaluated at quadpoint qp Also richards_vals(i) = &coupledValue

Definition at line 117 of file RichardsVarNames.C.

 {
   return _moose_var_value[richards_var_num]; // moose_var_value is a vector of pointers to
                                              // VariableValuees
 }

Referenced by RichardsMaterial::computePandSeff().

◆ richards_vals_old()

const VariableValue * RichardsVarNames::richards_vals_old ( unsigned int richards_var_num ) const

a vector of pointers to old VariableValues

Parameters

richards_var_num the richards variable number eg if richards_vars = 'pwater pgas', then (*richards_vals_old(1))[qp] = old pgas evaluated at quadpoint qp Also richards_vals_old(i) = &coupledValueOld

Definition at line 124 of file RichardsVarNames.C.

 {
   return _moose_var_value_old[richards_var_num];
 }

Referenced by RichardsMaterial::computePandSeff().

◆ richards_var_num()

unsigned int RichardsVarNames::richards_var_num ( unsigned int moose_var_num ) const

the richards variable number

Parameters

moose_var_num the MOOSE variable number eg if richards_vars = 'pwater pgas', and the variables in the simulation are 'temperature pwater pgas displacement' then richards_var_num(2) = 1

Definition at line 99 of file RichardsVarNames.C.

 {
   if (moose_var_num >= _ps_var_num.size() || _ps_var_num[moose_var_num] == _num_v)
     mooseError("The moose variable with number ",
                moose_var_num,
                " is not a richards according to the RichardsVarNames UserObject");
   return _ps_var_num[moose_var_num];
 }

Referenced by RichardsFlux::computeQpOffDiagJacobian(), RichardsMassChange::computeQpOffDiagJacobian(), RichardsHalfGaussianSink::computeQpOffDiagJacobian(), RichardsLumpedMassChange::computeQpOffDiagJacobian(), RichardsPolyLineSink::computeQpOffDiagJacobian(), RichardsPiecewiseLinearSink::computeQpOffDiagJacobian(), RichardsBorehole::computeQpOffDiagJacobian(), grad_var(), nodal_var(), nodal_var_old(), richards_vals(), richards_vals_old(), and RichardsFullyUpwindFlux::upwind().

◆ var_types()

std::string RichardsVarNames::var_types ( ) const

return the _var_types string

Definition at line 136 of file RichardsVarNames.C.

 {
   return _var_types;
 }

Referenced by RichardsMaterial::computePandSeff().

Member Data Documentation

◆ _moose_grad_var

std::vector<const VariableGradient *> RichardsVarNames::_moose_grad_var

protected

moose_grad_var[i] = gradient values of richards variable i

Definition at line 133 of file RichardsVarNames.h.

Referenced by grad_var(), and RichardsVarNames().

◆ _moose_nodal_var_value

std::vector<const VariableValue *> RichardsVarNames::_moose_nodal_var_value

protected

moose_var_value[i] = values of richards variable i

Definition at line 127 of file RichardsVarNames.h.

Referenced by nodal_var(), and RichardsVarNames().

◆ _moose_nodal_var_value_old

std::vector<const VariableValue *> RichardsVarNames::_moose_nodal_var_value_old

protected

moose_var_value_old[i] = old values of richards variable i

Definition at line 130 of file RichardsVarNames.h.

Referenced by nodal_var_old(), and RichardsVarNames().

◆ _moose_var_num

std::vector<unsigned int> RichardsVarNames::_moose_var_num

protected

_moose_var_num[i] = the moose variable number corresponding to richards variable i

Definition at line 113 of file RichardsVarNames.h.

Referenced by RichardsVarNames().

◆ _moose_var_value

std::vector<const VariableValue *> RichardsVarNames::_moose_var_value

protected

moose_var_value[i] = values of richards variable i

Definition at line 120 of file RichardsVarNames.h.

Referenced by richards_vals(), and RichardsVarNames().

◆ _moose_var_value_old

std::vector<const VariableValue *> RichardsVarNames::_moose_var_value_old

protected

moose_var_value_old[i] = old values of richards variable i

Definition at line 123 of file RichardsVarNames.h.

Referenced by richards_vals_old(), and RichardsVarNames().

◆ _num_v

unsigned int RichardsVarNames::_num_v

protected

number of richards variables

Definition at line 107 of file RichardsVarNames.h.

Referenced by not_richards_var(), num_v(), richards_var_num(), and RichardsVarNames().

◆ _ps_var_num

std::vector<unsigned int> RichardsVarNames::_ps_var_num

protected

_pressure_var_num[i] = the richards variable corresponding to moose variable i

Definition at line 116 of file RichardsVarNames.h.

Referenced by not_richards_var(), richards_var_num(), and RichardsVarNames().

◆ _var_types

MooseEnum RichardsVarNames::_var_types

protected

physical meaning of the variables. Eg 'pppp' means 'all variables are pressure variables'

Definition at line 110 of file RichardsVarNames.h.

Referenced by var_types().

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RichardsVarNames()

Member Function Documentation

◆ execute()

◆ finalize()

◆ grad_var()

◆ initialize()

◆ nodal_var()

◆ nodal_var_old()

◆ not_richards_var()

◆ num_v()

◆ richards_names()

◆ richards_vals()

◆ richards_vals_old()

◆ richards_var_num()

◆ var_types()

Member Data Documentation

◆ _moose_grad_var

◆ _moose_nodal_var_value

◆ _moose_nodal_var_value_old

◆ _moose_var_num

◆ _moose_var_value

◆ _moose_var_value_old

◆ _num_v

◆ _ps_var_num

◆ _var_types