NumericalFlux1D.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 NumericalFlux1D : public ThreadedGeneralUserObject
{
public:
  static InputParameters validParams();

  NumericalFlux1D(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<ADReal> & getFlux(const unsigned int iside,
                                              const dof_id_type ielem,
                                              bool res_side_is_left,
                                              const std::vector<ADReal> & UL_1d,
                                              const std::vector<ADReal> & UR_1d,
                                              Real nLR_dot_d) const;

  virtual const std::vector<ADReal> & getFlux3D(const unsigned int iside,
                                                const dof_id_type ielem,
                                                const std::vector<ADReal> & UL_3d,
                                                const std::vector<ADReal> & UR_3d,
                                                const RealVectorValue & nLR,
                                                const RealVectorValue & t1,
                                                const RealVectorValue & t2) const;

  virtual void calcFlux(const std::vector<ADReal> & UL_3d,
                        const std::vector<ADReal> & UR_3d,
                        const RealVectorValue & nLR,
                        const RealVectorValue & t1,
                        const RealVectorValue & t2,
                        std::vector<ADReal> & FL,
                        std::vector<ADReal> & FR) const = 0;

  unsigned int getLastRegionIndex() const { return _last_region_index; }

  virtual unsigned int getNumberOfRegions() const = 0;

protected:
  virtual std::vector<ADReal> convert1DInputTo3D(const std::vector<ADReal> & U_1d) const = 0;

  virtual std::vector<ADReal> convert3DFluxTo1D(const std::vector<ADReal> & F_3d) const = 0;

  virtual void transform3DFluxDirection(std::vector<ADReal> & F_3d, Real nLR_dot_d) const = 0;

  mutable unsigned int _cached_flux_elem_id;
  mutable unsigned int _cached_flux_side_id;

  mutable std::vector<ADReal> _FL_3d;
  mutable std::vector<ADReal> _FR_3d;
  mutable std::vector<ADReal> _FL_1d;
  mutable std::vector<ADReal> _FR_1d;

  mutable unsigned int _last_region_index;
};