PorousFlowDarcyBase.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 "Kernel.h"
#include "PorousFlowDictator.h"

class PorousFlowDarcyBase : public Kernel
{
public:
  static InputParameters validParams();

  PorousFlowDarcyBase(const InputParameters & parameters);

protected:
  virtual void timestepSetup() override;
  virtual Real computeQpResidual() override;
  virtual void computeResidual() override;
  virtual void computeJacobian() override;
  virtual void computeOffDiagJacobian(unsigned int jvar) override;

  virtual Real darcyQp(unsigned int ph) const;

  virtual Real darcyQpJacobian(unsigned int jvar, unsigned int ph) const;

  virtual Real mobility(unsigned nodenum, unsigned phase) const;

  virtual Real dmobility(unsigned nodenum, unsigned phase, unsigned pvar) const;

  enum class JacRes
  {
    CALCULATE_RESIDUAL = 0,
    CALCULATE_JACOBIAN = 1
  };

  using ResidualObject::computeResidualAndJacobian;

  void computeResidualAndJacobian(JacRes res_or_jac, unsigned int jvar);

  const MaterialProperty<RealTensorValue> & _permeability;

  const MaterialProperty<std::vector<RealTensorValue>> & _dpermeability_dvar;

  const MaterialProperty<std::vector<std::vector<RealTensorValue>>> & _dpermeability_dgradvar;

  const MaterialProperty<std::vector<Real>> & _fluid_density_node;

  const MaterialProperty<std::vector<std::vector<Real>>> & _dfluid_density_node_dvar;

  const MaterialProperty<std::vector<Real>> & _fluid_density_qp;

  const MaterialProperty<std::vector<std::vector<Real>>> & _dfluid_density_qp_dvar;

  const MaterialProperty<std::vector<Real>> & _fluid_viscosity;

  const MaterialProperty<std::vector<std::vector<Real>>> & _dfluid_viscosity_dvar;

  const MaterialProperty<std::vector<Real>> & _pp;

  const MaterialProperty<std::vector<RealGradient>> & _grad_p;

  const MaterialProperty<std::vector<std::vector<Real>>> & _dgrad_p_dgrad_var;

  const MaterialProperty<std::vector<std::vector<RealGradient>>> & _dgrad_p_dvar;

  const PorousFlowDictator & _dictator;

  const unsigned int _num_phases;

  const RealVectorValue _gravity;

  const bool _perm_derivs;

  const unsigned _full_upwind_threshold;

  const enum class FallbackEnum { QUICK, HARMONIC } _fallback_scheme;

  std::vector<std::vector<Real>> _proto_flux;

  std::vector<std::vector<std::vector<Real>>> _jacobian;

  std::unordered_map<unsigned, std::vector<std::vector<unsigned>>> _num_upwinds;

  std::unordered_map<unsigned, std::vector<std::vector<unsigned>>> _num_downwinds;

  void fullyUpwind(JacRes res_or_jac, unsigned int ph, unsigned int pvar);

  void quickUpwind(JacRes res_or_jac, unsigned int ph, unsigned int pvar);

  void harmonicMean(JacRes res_or_jac, unsigned int ph, unsigned int pvar);
};