Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/PDE/MultiMat/Physics/FVEnergyPill.hpp
       4                 :            :   \copyright 2012-2015 J. Bakosi,
       5                 :            :              2016-2018 Los Alamos National Security, LLC.,
       6                 :            :              2019-2021 Triad National Security, LLC.
       7                 :            :              All rights reserved. See the LICENSE file for details.
       8                 :            :   \brief     Physics policy for the Euler equation governing multi-material flow
       9                 :            :     using a finite volume method
      10                 :            :   \details   This file defines a Physics policy class for the compressible
      11                 :            :     flow equations class fv::MultiMat, defined in PDE/MultiMat/FVMultiMat.h.
      12                 :            :     This specific class allows energy pill initialization of a user defined
      13                 :            :     box/block for multi-material flow. See PDE/MultiMat/Physics/FV.h for general
      14                 :            :     requirements on Physics policy classes for fv::MultiMat.
      15                 :            : */
      16                 :            : // *****************************************************************************
      17                 :            : #ifndef MultiMatPhysicsFVEnergyPill_h
      18                 :            : #define MultiMatPhysicsFVEnergyPill_h
      19                 :            : 
      20                 :            : #include "Inciter/Options/Physics.hpp"
      21                 :            : #include "Fields.hpp"
      22                 :            : 
      23                 :            : namespace inciter {
      24                 :            : 
      25                 :            : namespace fv {
      26                 :            : 
      27                 :            : //! MultiMat system of PDEs problem: EnergyPill (velocity equilibrium)
      28                 :            : //! \details This class implements additional physics needed on top of the
      29                 :            : //!   basic MultiMat Euler equations governing multi-material compressible flow.
      30                 :            : class MultiMatPhysicsEnergyPill {
      31                 :            : 
      32                 :            :   public:
      33                 :            :     //! Compute the time step size restriction based on this physics
      34                 :            :     tk::real dtRestriction(
      35                 :            :       const tk::Fields& geoElem,
      36                 :            :       std::size_t nelem,
      37                 :            :       const std::vector< int >& engSrcAd ) const;
      38                 :            : 
      39                 :            :     //! Compute sources corresponding to this physics
      40                 :            :     void physSrc(
      41                 :            :       std::size_t nmat,
      42                 :            :       tk::real t,
      43                 :            :       const tk::Fields& geoElem,
      44                 :            :       const std::unordered_map< std::size_t, std::set< std::size_t > >&
      45                 :            :         elemblkid,
      46                 :            :       tk::Fields& R,
      47                 :            :       std::vector< int >& engSrcAdded ) const;
      48                 :            : 
      49                 :            :     //! Return enum denoting physics policy
      50                 :            :     //! \return Enum denoting physics policy.
      51                 :      45420 :     static ctr::PhysicsType type() noexcept {
      52                 :      45420 :       return ctr::PhysicsType::ENERGYPILL; }
      53                 :            : };
      54                 :            : 
      55                 :            : } // fv::
      56                 :            : 
      57                 :            : } // inciter::
      58                 :            : 
      59                 :            : #endif // CompFlowPhysicsFVMultiMatEnergyPill_h