ConservativeAdvection.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 "libmesh/dense_vector.h"

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

  ConservativeAdvectionTempl(const InputParameters & parameters);

protected:
  virtual GenericReal<is_ad> computeQpResidual() override;
  virtual Real computeQpJacobian() override;
  virtual Real computeQpOffDiagJacobian(unsigned int jvar) override;
  virtual void computeResidual() override;
  virtual void computeJacobian() override;
  virtual const GenericReal<is_ad> & getUNodal(const std::size_t n) const { return _u_nodal[n]; }

  const GenericMaterialProperty<Real, is_ad> & _scalar;

  const bool _coupled_variable_present;

  const unsigned int _coupled_variable_var;

  const MooseArray<GenericRealVectorValue<is_ad>> * _velocity;

  const bool _user_supplied_adv_quant;

  const MooseArray<GenericReal<is_ad>> & _adv_quant;

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

  const enum class UpwindingType { none, full } _upwinding;

  const GenericVariableValue<is_ad> & _u_nodal;

  std::vector<bool> _upwind_node;

  std::vector<GenericReal<is_ad>> _dtotal_mass_out;

  virtual GenericReal<is_ad> negSpeedQp() const;

  void fullUpwind(JacRes res_or_jac);

  usingGenericKernelMembers;

private:
  libMesh::DenseVector<GenericReal<is_ad>> _my_local_re;
};

typedef ConservativeAdvectionTempl<false> ConservativeAdvection;
typedef ConservativeAdvectionTempl<true> ADConservativeAdvection;