PorousFlowFluidStateBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* 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"

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){};

  ADReal pressure;
  ADReal temperature;
  ADReal saturation;
  ADReal density;
  ADReal viscosity;
  ADReal enthalpy;
  ADReal internal_energy;
  std::vector<ADReal> mass_fraction;
};

class PorousFlowFluidStateBase : public GeneralUserObject
{
public:
  static InputParameters validParams();

  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; };

  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 Real _R;
  const Real _T_c2k;
  const PorousFlowCapillaryPressure & _pc;
  FluidStateProperties _empty_fsp;
};