PorousFlowVariableBase Class Reference

Base class for thermophysical variable materials, which assemble materials for primary variables such as porepressure and saturation at the nodes and quadpoints for all phases as required. More...

#include <PorousFlowVariableBase.h>

Inheritance diagram for PorousFlowVariableBase:

Public Member Functions
	PorousFlowVariableBase (const InputParameters &parameters)

Protected Member Functions
virtual void	initQpStatefulProperties () override
virtual void	computeQpProperties () override

Protected Attributes
const unsigned int	_num_phases
	Number of phases. More...
const unsigned int	_num_components
	Number of components. More...
const unsigned int	_num_pf_vars
	Number of PorousFlow variables. More...
MaterialProperty< std::vector< Real > > &	_porepressure
	Computed nodal or quadpoint values of porepressure of the phases. More...
MaterialProperty< std::vector< std::vector< Real > > > &	_dporepressure_dvar
	d(porepressure)/d(PorousFlow variable) More...
MaterialProperty< std::vector< RealGradient > > *const	_gradp_qp
	Grad(p) at the quadpoints. More...
MaterialProperty< std::vector< std::vector< Real > > > *const	_dgradp_qp_dgradv
	d(grad porepressure)/d(grad PorousFlow variable) at the quadpoints More...
MaterialProperty< std::vector< std::vector< RealGradient > > > *const	_dgradp_qp_dv
	d(grad porepressure)/d(PorousFlow variable) at the quadpoints More...
MaterialProperty< std::vector< Real > > &	_saturation
	Computed nodal or qp saturation of the phases. More...
MaterialProperty< std::vector< std::vector< Real > > > &	_dsaturation_dvar
	d(saturation)/d(PorousFlow variable) More...
MaterialProperty< std::vector< RealGradient > > *const	_grads_qp
	Grad(s) at the quadpoints. More...
MaterialProperty< std::vector< std::vector< Real > > > *const	_dgrads_qp_dgradv
	d(grad saturation)/d(grad PorousFlow variable) at the quadpoints More...
MaterialProperty< std::vector< std::vector< RealGradient > > > *const	_dgrads_qp_dv
	d(grad saturation)/d(PorousFlow variable) at the quadpoints More...

Detailed Description

Base class for thermophysical variable materials, which assemble materials for primary variables such as porepressure and saturation at the nodes and quadpoints for all phases as required.

Definition at line 25 of file PorousFlowVariableBase.h.

Constructor & Destructor Documentation

PorousFlowVariableBase()

PorousFlowVariableBase::PorousFlowVariableBase

(

const InputParameters &

parameters

)

Definition at line 23 of file PorousFlowVariableBase.C.

  : DerivativeMaterialInterface<PorousFlowMaterial>(parameters),
 
    _num_phases(_dictator.numPhases()),
    _num_components(_dictator.numComponents()),
    _num_pf_vars(_dictator.numVariables()),
 
    _porepressure(_nodal_material
                      ? declareProperty<std::vector<Real>>("PorousFlow_porepressure_nodal")
                      : declareProperty<std::vector<Real>>("PorousFlow_porepressure_qp")),
    _dporepressure_dvar(
        _nodal_material
            ? declareProperty<std::vector<std::vector<Real>>>("dPorousFlow_porepressure_nodal_dvar")
            : declareProperty<std::vector<std::vector<Real>>>("dPorousFlow_porepressure_qp_dvar")),
    _gradp_qp(_nodal_material
                  ? nullptr
                  : &declareProperty<std::vector<RealGradient>>("PorousFlow_grad_porepressure_qp")),
    _dgradp_qp_dgradv(_nodal_material ? nullptr
                                      : &declareProperty<std::vector<std::vector<Real>>>(
                                            "dPorousFlow_grad_porepressure_qp_dgradvar")),
    _dgradp_qp_dv(_nodal_material ? nullptr
                                  : &declareProperty<std::vector<std::vector<RealGradient>>>(
                                        "dPorousFlow_grad_porepressure_qp_dvar")),
 
    _saturation(_nodal_material ? declareProperty<std::vector<Real>>("PorousFlow_saturation_nodal")
                                : declareProperty<std::vector<Real>>("PorousFlow_saturation_qp")),
    _dsaturation_dvar(
        _nodal_material
            ? declareProperty<std::vector<std::vector<Real>>>("dPorousFlow_saturation_nodal_dvar")
            : declareProperty<std::vector<std::vector<Real>>>("dPorousFlow_saturation_qp_dvar")),
    _grads_qp(_nodal_material
                  ? nullptr
                  : &declareProperty<std::vector<RealGradient>>("PorousFlow_grad_saturation_qp")),
    _dgrads_qp_dgradv(_nodal_material ? nullptr
                                      : &declareProperty<std::vector<std::vector<Real>>>(
                                            "dPorousFlow_grad_saturation_qp_dgradvar")),
    _dgrads_qp_dv(_nodal_material ? nullptr
                                  : &declareProperty<std::vector<std::vector<RealGradient>>>(
                                        "dPorousFlow_grad_saturation_qp_dvar"))
{
}

Member Function Documentation

computeQpProperties()

void PorousFlowVariableBase::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented in PorousFlowFluidState, PorousFlowFluidStateSingleComponent, PorousFlow2PhasePS, PorousFlow1PhaseMD_Gaussian, PorousFlow1PhaseP, PorousFlow1PhaseFullySaturated, and PorousFlow2PhasePP.

Definition at line 74 of file PorousFlowVariableBase.C.

{
  // do we really need this stuff here?  it seems very inefficient to keep resizing everything!
  _porepressure[_qp].resize(_num_phases);
  _dporepressure_dvar[_qp].resize(_num_phases);
 
  _saturation[_qp].resize(_num_phases);
  _dsaturation_dvar[_qp].resize(_num_phases);
 
  if (!_nodal_material)
  {
    (*_gradp_qp)[_qp].resize(_num_phases);
    (*_dgradp_qp_dgradv)[_qp].resize(_num_phases);
    (*_dgradp_qp_dv)[_qp].resize(_num_phases);
 
    (*_grads_qp)[_qp].resize(_num_phases);
    (*_dgrads_qp_dgradv)[_qp].resize(_num_phases);
    (*_dgrads_qp_dv)[_qp].resize(_num_phases);
  }
 
  // Prepare the derivative matrices with zeroes
  for (unsigned phase = 0; phase < _num_phases; ++phase)
  {
    _dporepressure_dvar[_qp][phase].assign(_num_pf_vars, 0.0);
    _dsaturation_dvar[_qp][phase].assign(_num_pf_vars, 0.0);
    if (!_nodal_material)
    {
      (*_dgradp_qp_dgradv)[_qp][phase].assign(_num_pf_vars, 0.0);
      (*_dgradp_qp_dv)[_qp][phase].assign(_num_pf_vars, RealGradient());
      (*_dgrads_qp_dgradv)[_qp][phase].assign(_num_pf_vars, 0.0);
      (*_dgrads_qp_dv)[_qp][phase].assign(_num_pf_vars, RealGradient());
    }
  }
}

Referenced by PorousFlow1PhaseFullySaturated::computeQpProperties(), PorousFlow2PhasePP::computeQpProperties(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), PorousFlow1PhaseP::computeQpProperties(), PorousFlow2PhasePS::computeQpProperties(), PorousFlowFluidStateSingleComponent::computeQpProperties(), and PorousFlowFluidState::computeQpProperties().

initQpStatefulProperties()

void PorousFlowVariableBase::initQpStatefulProperties ( )

overrideprotectedvirtual

Reimplemented in PorousFlowFluidState, PorousFlowFluidStateSingleComponent, PorousFlow2PhasePS, PorousFlow1PhaseMD_Gaussian, PorousFlow1PhaseP, PorousFlow1PhaseFullySaturated, and PorousFlow2PhasePP.

Definition at line 66 of file PorousFlowVariableBase.C.

{
  _porepressure[_qp].resize(_num_phases);
  _saturation[_qp].resize(_num_phases);
  // the porepressure and saturation values get set by derived classes
}

Referenced by PorousFlow1PhaseFullySaturated::initQpStatefulProperties(), PorousFlow2PhasePP::initQpStatefulProperties(), PorousFlow1PhaseMD_Gaussian::initQpStatefulProperties(), PorousFlow1PhaseP::initQpStatefulProperties(), PorousFlow2PhasePS::initQpStatefulProperties(), PorousFlowFluidStateSingleComponent::initQpStatefulProperties(), and PorousFlowFluidState::initQpStatefulProperties().

Member Data Documentation

_dgradp_qp_dgradv

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBase::_dgradp_qp_dgradv

protected

d(grad porepressure)/d(grad PorousFlow variable) at the quadpoints

Definition at line 53 of file PorousFlowVariableBase.h.

Referenced by PorousFlowFluidStateSingleComponent::computeQpProperties(), and PorousFlowFluidState::computeQpProperties().

_dgradp_qp_dv

MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBase::_dgradp_qp_dv

protected

d(grad porepressure)/d(PorousFlow variable) at the quadpoints

Definition at line 56 of file PorousFlowVariableBase.h.

_dgrads_qp_dgradv

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBase::_dgrads_qp_dgradv

protected

d(grad saturation)/d(grad PorousFlow variable) at the quadpoints

Definition at line 68 of file PorousFlowVariableBase.h.

_dgrads_qp_dv

MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBase::_dgrads_qp_dv

protected

d(grad saturation)/d(PorousFlow variable) at the quadpoints

Definition at line 71 of file PorousFlowVariableBase.h.

_dporepressure_dvar

MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowVariableBase::_dporepressure_dvar

protected

d(porepressure)/d(PorousFlow variable)

Definition at line 47 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseFullySaturated::computeQpProperties(), PorousFlow2PhasePP::computeQpProperties(), computeQpProperties(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), PorousFlow1PhaseP::computeQpProperties(), PorousFlow2PhasePS::computeQpProperties(), PorousFlowFluidStateSingleComponent::computeQpProperties(), and PorousFlowFluidState::computeQpProperties().

_dsaturation_dvar

MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowVariableBase::_dsaturation_dvar

protected

d(saturation)/d(PorousFlow variable)

Definition at line 62 of file PorousFlowVariableBase.h.

Referenced by PorousFlow2PhasePP::computeQpProperties(), computeQpProperties(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), PorousFlow1PhaseP::computeQpProperties(), PorousFlow2PhasePS::computeQpProperties(), PorousFlowFluidStateSingleComponent::computeQpProperties(), and PorousFlowFluidState::computeQpProperties().

_gradp_qp

MaterialProperty<std::vector<RealGradient> >* const PorousFlowVariableBase::_gradp_qp

protected

Grad(p) at the quadpoints.

Definition at line 50 of file PorousFlowVariableBase.h.

_grads_qp

MaterialProperty<std::vector<RealGradient> >* const PorousFlowVariableBase::_grads_qp

protected

Grad(s) at the quadpoints.

Definition at line 65 of file PorousFlowVariableBase.h.

_num_components

const unsigned int PorousFlowVariableBase::_num_components

protected

Number of components.

Definition at line 38 of file PorousFlowVariableBase.h.

Referenced by PorousFlowFluidStateSingleComponent::computeQpProperties(), PorousFlowFluidState::computeQpProperties(), PorousFlowFluidState::initQpStatefulProperties(), PorousFlowFluidState::PorousFlowFluidState(), PorousFlowFluidStateSingleComponent::PorousFlowFluidStateSingleComponent(), PorousFlowFluidStateSingleComponent::setMaterialVectorSize(), and PorousFlowFluidState::setMaterialVectorSize().

_num_pf_vars

const unsigned int PorousFlowVariableBase::_num_pf_vars

protected

Number of PorousFlow variables.

Definition at line 41 of file PorousFlowVariableBase.h.

Referenced by computeQpProperties(), PorousFlowFluidStateSingleComponent::setMaterialVectorSize(), and PorousFlowFluidState::setMaterialVectorSize().

_num_phases

const unsigned int PorousFlowVariableBase::_num_phases

protected

Number of phases.

Definition at line 35 of file PorousFlowVariableBase.h.

Referenced by computeQpProperties(), PorousFlow2PhasePS::computeQpProperties(), PorousFlowFluidStateSingleComponent::computeQpProperties(), PorousFlowFluidState::computeQpProperties(), initQpStatefulProperties(), PorousFlowFluidStateSingleComponent::initQpStatefulProperties(), PorousFlowFluidState::initQpStatefulProperties(), PorousFlow1PhaseFullySaturated::PorousFlow1PhaseFullySaturated(), PorousFlow1PhaseMD_Gaussian::PorousFlow1PhaseMD_Gaussian(), PorousFlow1PhaseP::PorousFlow1PhaseP(), PorousFlow2PhasePP::PorousFlow2PhasePP(), PorousFlowFluidState::PorousFlowFluidState(), PorousFlowFluidStateSingleComponent::PorousFlowFluidStateSingleComponent(), PorousFlowFluidStateSingleComponent::setMaterialVectorSize(), and PorousFlowFluidState::setMaterialVectorSize().

_porepressure

MaterialProperty<std::vector<Real> >& PorousFlowVariableBase::_porepressure

protected

Computed nodal or quadpoint values of porepressure of the phases.

Definition at line 44 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseMD_Gaussian::buildPS(), PorousFlow2PhasePS::buildQpPPSS(), PorousFlow1PhaseFullySaturated::buildQpPPSS(), PorousFlow1PhaseP::buildQpPPSS(), PorousFlow2PhasePP::buildQpPPSS(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), computeQpProperties(), PorousFlowFluidStateSingleComponent::computeQpProperties(), PorousFlowFluidState::computeQpProperties(), initQpStatefulProperties(), PorousFlowFluidStateSingleComponent::initQpStatefulProperties(), and PorousFlowFluidState::initQpStatefulProperties().

_saturation

MaterialProperty<std::vector<Real> >& PorousFlowVariableBase::_saturation

protected

Computed nodal or qp saturation of the phases.

Definition at line 59 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseMD_Gaussian::buildPS(), PorousFlow2PhasePS::buildQpPPSS(), PorousFlow1PhaseFullySaturated::buildQpPPSS(), PorousFlow1PhaseP::buildQpPPSS(), PorousFlow2PhasePP::buildQpPPSS(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), computeQpProperties(), PorousFlowFluidStateSingleComponent::computeQpProperties(), PorousFlowFluidState::computeQpProperties(), initQpStatefulProperties(), PorousFlowFluidStateSingleComponent::initQpStatefulProperties(), and PorousFlowFluidState::initQpStatefulProperties().

---

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

• porous_flow/include/materials/PorousFlowVariableBase.h
• porous_flow/src/materials/PorousFlowVariableBase.C