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

template <bool is_ad>
class PorousFlowDarcyBaseTempl : public GenericKernel<is_ad>
{
public:
  static InputParameters validParams();

  PorousFlowDarcyBaseTempl(const InputParameters & parameters);

protected:
  virtual void timestepSetup() override;
  virtual void jacobianSetup() override;
  virtual GenericReal<is_ad> computeQpResidual() override;
  virtual void computeResidual() override;
  virtual void computeJacobian() override;
  virtual void computeOffDiagJacobian(unsigned int jvar) override;

  virtual GenericReal<is_ad> darcyQp(unsigned int ph) const;

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

  virtual GenericReal<is_ad> 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 GenericMaterialProperty<RealTensorValue, is_ad> & _permeability;

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

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

  const GenericMaterialProperty<std::vector<Real>, is_ad> & _fluid_density_node;

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

  const GenericMaterialProperty<std::vector<Real>, is_ad> & _fluid_density_qp;

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

  const GenericMaterialProperty<std::vector<Real>, is_ad> & _fluid_viscosity;

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

  const GenericMaterialProperty<std::vector<Real>, is_ad> & _pp;

  const GenericMaterialProperty<std::vector<RealGradient>, is_ad> & _grad_p;

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

  const MaterialProperty<std::vector<std::vector<RealGradient>>> * const _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<GenericReal<is_ad>>> _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);

  usingGenericKernelMembers;
  using GenericKernel<is_ad>::_grad_phi;

private:
  void computeProtoFluxWithoutMobility();

  void initializeUpwindTracking(unsigned elem, unsigned int num_nodes);

  void updateUpwindCounts(unsigned elem, unsigned int num_nodes);

  std::vector<unsigned> computeMaxSwaps(unsigned elem, unsigned int num_nodes) const;

  void
  applyUpwinding(const std::vector<unsigned> & max_swaps, JacRes res_or_jac, unsigned int pvar);

  void adComputeProtoFlux(bool do_counting);

  void adComputeJacobian();

  void assembleProtoFluxResidual();

  const Elem * _my_elem_darcy = nullptr;
};

typedef PorousFlowDarcyBaseTempl<false> PorousFlowDarcyBase;
typedef PorousFlowDarcyBaseTempl<true> ADPorousFlowDarcyBase;