NumericalFlux3EqnBase.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 "ThreadedGeneralUserObject.h"

class NumericalFlux3EqnBase : public ThreadedGeneralUserObject
{
public:
  NumericalFlux3EqnBase(const InputParameters & parameters);

  virtual void execute() override;
  virtual void initialize() override;
  virtual void finalize() override;
  virtual void threadJoin(const UserObject &) override;

  virtual const std::vector<Real> & getFlux(const unsigned int iside,
                                            const dof_id_type ielem,
                                            bool res_side_is_left,
                                            const std::vector<Real> & UL,
                                            const std::vector<Real> & UR,
                                            const Real & nLR_dot_d) const;

  virtual const DenseMatrix<Real> & getJacobian(bool res_side_is_left,
                                                bool jac_side_is_left,
                                                const unsigned int iside,
                                                const dof_id_type ielem,
                                                const std::vector<Real> & UL,
                                                const std::vector<Real> & UR,
                                                const Real & nLR_dot_d) const;

  virtual void calcFlux(const std::vector<Real> & UL,
                        const std::vector<Real> & UR,
                        const Real & nLR_dot_d,
                        std::vector<Real> & FL,
                        std::vector<Real> & FR) const = 0;

  virtual void calcJacobian(const std::vector<Real> & UL,
                            const std::vector<Real> & UR,
                            const Real & nLR_dot_d,
                            DenseMatrix<Real> & dFL_dUL,
                            DenseMatrix<Real> & dFL_dUR,
                            DenseMatrix<Real> & dFR_dUL,
                            DenseMatrix<Real> & dFR_dUR) const = 0;

  unsigned int getLastRegionIndex() const { return _last_region_index; }

  virtual unsigned int getNumberOfRegions() const = 0;

protected:
  mutable unsigned int _cached_flux_elem_id;
  mutable unsigned int _cached_flux_side_id;

  mutable unsigned int _cached_jacobian_elem_id;
  mutable unsigned int _cached_jacobian_side_id;

  mutable std::vector<Real> _FL;
  mutable std::vector<Real> _FR;
  mutable DenseMatrix<Real> _dFL_dUL;
  mutable DenseMatrix<Real> _dFL_dUR;
  mutable DenseMatrix<Real> _dFR_dUL;
  mutable DenseMatrix<Real> _dFR_dUR;

  mutable unsigned int _last_region_index;

public:
  static InputParameters validParams();
};