PorousFlowFluidStateBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include "GeneralUserObject.h"
#include "PorousFlowCapillaryPressure.h"
 
class PorousFlowFluidStateBase;
 
enum class FluidStatePhaseEnum
{
  LIQUID,
  GAS,
  TWOPHASE
};
 
struct FluidStateProperties
{
  FluidStateProperties(){};
  FluidStateProperties(unsigned int n)
    : pressure(0.0),
      temperature(0, 0),
      saturation(0.0),
      density(0.0),
      viscosity(1.0), // to guard against division by zero
      enthalpy(0.0),
      internal_energy(0.0),
      mass_fraction(n, 0.0){};
 
  DualReal pressure;
  DualReal temperature;
  DualReal saturation;
  DualReal density;
  DualReal viscosity;
  DualReal enthalpy;
  DualReal internal_energy;
  std::vector<DualReal> mass_fraction;
};
 
template <>
InputParameters validParams<PorousFlowFluidStateBase>();
 
class PorousFlowFluidStateBase : public GeneralUserObject
{
public:
  PorousFlowFluidStateBase(const InputParameters & parameters);
 
  void initialize() final{};
  void execute() final{};
  void finalize() final{};
 
  unsigned int numPhases() const { return _num_phases; };
 
  unsigned int numComponents() const { return _num_components; };
 
  unsigned int aqueousPhaseIndex() const { return _aqueous_phase_number; };
 
  unsigned int gasPhaseIndex() const { return _gas_phase_number; };
 
  unsigned int aqueousComponentIndex() const { return _aqueous_fluid_component; };
 
  unsigned int gasComponentIndex() const { return _gas_fluid_component; };
 
  unsigned int saltComponentIndex() const { return _salt_component; };
 
  virtual std::string fluidStateName() const = 0;
 
  void clearFluidStateProperties(std::vector<FluidStateProperties> & fsp) const;
 
protected:
  unsigned int _num_phases;
  unsigned int _num_components;
  const unsigned int _aqueous_phase_number;
  unsigned int _gas_phase_number;
  const unsigned int _aqueous_fluid_component;
  unsigned int _gas_fluid_component;
  const unsigned int _salt_component;
  const Real _R;
  const Real _T_c2k;
  const PorousFlowCapillaryPressure & _pc;
  FluidStateProperties _empty_fsp;
};