PorousFlowFluidStateBaseMaterial.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 "PorousFlowVariableBase.h"
#include "PorousFlowFluidStateBase.h"

class PorousFlowCapillaryPressure;

template <bool is_ad>
class PorousFlowFluidStateBaseMaterialTempl : public PorousFlowVariableBaseTempl<is_ad>
{
public:
  static InputParameters validParams();

  PorousFlowFluidStateBaseMaterialTempl(const InputParameters & parameters);

protected:
  virtual void initQpStatefulProperties() override;
  virtual void computeQpProperties() override;

  virtual void setMaterialVectorSize() const;

  virtual void thermophysicalProperties() = 0;

  GenericReal<is_ad> genericValue(const ADReal & value);

  const Real _T_c2k;
  bool _is_initqp;
  std::vector<FluidStateProperties> _fsp;
  const PorousFlowCapillaryPressure & _pc;
  const std::string _sfx;

  GenericMaterialProperty<std::vector<std::vector<Real>>, is_ad> & _mass_frac;
  GenericMaterialProperty<std::vector<std::vector<RealGradient>>, is_ad> * const _grad_mass_frac_qp;
  MaterialProperty<std::vector<std::vector<std::vector<Real>>>> * const _dmass_frac_dvar;
  GenericMaterialProperty<std::vector<Real>, is_ad> & _fluid_density;
  MaterialProperty<std::vector<std::vector<Real>>> * const _dfluid_density_dvar;
  GenericMaterialProperty<std::vector<Real>, is_ad> & _fluid_viscosity;
  MaterialProperty<std::vector<std::vector<Real>>> * const _dfluid_viscosity_dvar;
  GenericMaterialProperty<std::vector<Real>, is_ad> & _fluid_enthalpy;
  MaterialProperty<std::vector<std::vector<Real>>> * const _dfluid_enthalpy_dvar;
  GenericMaterialProperty<std::vector<Real>, is_ad> & _fluid_internal_energy;
  MaterialProperty<std::vector<std::vector<Real>>> * const _dfluid_internal_energy_dvar;

  usingPorousFlowVariableBaseMembers;
  using PorousFlowVariableBaseTempl<is_ad>::_num_components;
  using PorousFlowVariableBaseTempl<is_ad>::_num_pf_vars;
};

#define usingPorousFlowFluidStateBaseMaterialMembers                                               \
  usingPorousFlowVariableBaseMembers;                                                              \
  using Coupleable::coupledComponents;                                                             \
  using Coupleable::getFieldVar;                                                                   \
  using Coupleable::isCoupled;                                                                     \
  using PorousFlowVariableBaseTempl<is_ad>::name;                                                  \
  using PorousFlowVariableBaseTempl<is_ad>::_num_components;                                       \
  using PorousFlowVariableBaseTempl<is_ad>::_num_pf_vars;                                          \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_T_c2k;                                      \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_fsp;                                        \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_sfx;                                        \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_pc;                                         \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_is_initqp;                                  \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::genericValue;                                \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::setMaterialVectorSize;                       \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_mass_frac;                                  \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_grad_mass_frac_qp;                          \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_fluid_density;                              \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_fluid_viscosity;                            \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_fluid_enthalpy;                             \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_fluid_internal_energy

#define usingPorousFlowFluidStateBaseMaterialDerivativeMembers                                     \
  usingPorousFlowFluidStateBaseMaterialMembers;                                                    \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_dmass_frac_dvar;                            \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_dfluid_density_dvar;                        \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_dfluid_viscosity_dvar;                      \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_dfluid_enthalpy_dvar;                       \
  using PorousFlowFluidStateBaseMaterialTempl<is_ad>::_dfluid_internal_energy_dvar