template<class Physics, class Problem>
MultiMat class
MultiMat used polymorphically with tk::FVPDE.
Contents
The template arguments specify policies and are used to configure the behavior of the class. The policies are:
- Physics - physics configuration, see PDE/MultiMat/Physics.h
Problem - problem configuration, see PDE/MultiMat/Problem.h
Constructors, destructors, conversion operators
- MultiMat() explicit
- Constructor.
Public functions
- auto nprim() const -> std::size_t
- auto nmat() const -> std::size_t
- void IcBoxElems(const tk::Fields& geoElem, std::size_t nielem, std::vector<std::unordered_set<std::size_t>>& inbox) const
-
void initialize(const tk::Fields& L,
const std::vector<std::size_t>& inpoel,
const tk::
UnsMesh:: Coords& coord, const std::vector<std::unordered_set<std::size_t>>& inbox, const std::unordered_map<std::size_t, std::set<std::size_t>>& elemblkid, tk::Fields& unk, tk:: real t, const std::size_t nielem) const - void lhs(const tk::Fields& geoElem, tk::Fields& l) const
- void updatePrimitives(const tk::Fields& unk, tk::Fields& prim, std::size_t nielem) const
-
void cleanTraceMaterial(tk::
real t, const tk::Fields& geoElem, tk::Fields& unk, tk::Fields& prim, std::size_t nielem) const -
void reconstruct(const tk::Fields& geoElem,
const inciter::
FaceData& fd, const std::map<std::size_t, std::vector<std::size_t>>& esup, const std::vector<std::size_t>& inpoel, const tk:: UnsMesh:: Coords& coord, tk::Fields& U, tk::Fields& P) const -
void limit(const tk::Fields& geoFace,
const inciter::
FaceData& fd, const std::map<std::size_t, std::vector<std::size_t>>& esup, const std::vector<std::size_t>& inpoel, const tk:: UnsMesh:: Coords& coord, const std::vector<int>& srcFlag, tk::Fields& U, tk::Fields& P) const -
void CPL(const tk::Fields& prim,
const tk::Fields& geoElem,
const std::vector<std::size_t>& inpoel,
const tk::
UnsMesh:: Coords& coord, tk::Fields& unk, std::size_t nielem) const -
void rhs(tk::
real t, const tk::Fields& geoFace, const tk::Fields& geoElem, const inciter:: FaceData& fd, const std::vector<std::size_t>& inpoel, const tk:: UnsMesh:: Coords& coord, const std::unordered_map<std::size_t, std::set<std::size_t>>& elemblkid, const tk::Fields& U, const tk::Fields& P, tk::Fields& R, std::vector<int>& srcFlag) const -
auto dt(const inciter::
FaceData&, const tk::Fields&, const tk::Fields& geoElem, const tk::Fields& U, const tk::Fields& P, const std::size_t nielem, const std::vector<int>& srcFlag, std::vector<tk:: real>& local_dte) const -> tk:: real - Compute the minimum time step size.
-
auto velocity(const tk::Fields& U,
const std::array<std::vector<tk::
real>, 3>&, const std::array<std::size_t, 4>& N) const -> std::array<std::array<tk:: real, 4>, 3> -
auto OutVarFn() const -> std::map<std::string, tk::
GetVarFn> - auto analyticFieldNames() const -> std::vector<std::string>
- auto surfNames() const -> std::vector<std::string>
- auto histNames() const -> std::vector<std::string>
-
auto surfOutput(const inciter::
FaceData& fd, const tk::Fields& U, const tk::Fields& P) const -> std::vector<std::vector<tk:: real>> - Return surface field output going to file.
-
auto histOutput(const std::vector<HistData>& h,
const std::vector<std::size_t>& inpoel,
const tk::
UnsMesh:: Coords& coord, const tk::Fields& U, const tk::Fields& P) const -> std::vector<std::vector<tk:: real>> - auto names() const -> std::vector<std::string>
-
auto analyticSolution(tk::
real xi, tk:: real yi, tk:: real zi, tk:: real t) const -> std::vector<tk:: real> -
auto solution(tk::
real xi, tk:: real yi, tk:: real zi, tk:: real t) const -> std::vector<tk:: real> -
auto sp_totalenergy(std::size_t e,
const tk::Fields& unk) const -> tk::
real -
void soundspeed(std::size_t nielem,
const tk::Fields& U,
const tk::Fields& P,
std::vector<tk::
real>& ss) const
Function documentation
template<class Physics, class Problem>
std::size_t inciter:: fv:: MultiMat<Physics, Problem>:: nprim() const
Returns | The number of primitive quantities required to be stored for this PDE system |
---|
Find the number of primitive quantities required for this PDE system
template<class Physics, class Problem>
std::size_t inciter:: fv:: MultiMat<Physics, Problem>:: nmat() const
Returns | The number of materials set up for this PDE system |
---|
Find the number of materials set up for this PDE system
template<class Physics, class Problem>
void inciter:: fv:: MultiMat<Physics, Problem>:: IcBoxElems(const tk::Fields& geoElem,
std::size_t nielem,
std::vector<std::unordered_set<std::size_t>>& inbox) const
Parameters | |
---|---|
geoElem in | Element geometry array |
nielem in | Number of internal elements |
inbox in/out | List of nodes at which box user ICs are set for each IC box |
Determine elements that lie inside the user-defined IC box
template<class Physics, class Problem>
void inciter:: fv:: MultiMat<Physics, Problem>:: initialize(const tk::Fields& L,
const std::vector<std::size_t>& inpoel,
const tk:: UnsMesh:: Coords& coord,
const std::vector<std::unordered_set<std::size_t>>& inbox,
const std::unordered_map<std::size_t, std::set<std::size_t>>& elemblkid,
tk::Fields& unk,
tk:: real t,
const std::size_t nielem) const
Parameters | |
---|---|
L in | Block diagonal mass matrix |
inpoel in | Element-node connectivity |
coord in | Array of nodal coordinates |
inbox in | List of elements at which box user ICs are set for each IC box |
elemblkid in | Element ids associated with mesh block ids where user ICs are set |
unk in/out | Array of unknowns |
t in | Physical time |
nielem in | Number of internal elements |
Initalize the compressible flow equations, prepare for time integration
template<class Physics, class Problem>
void inciter:: fv:: MultiMat<Physics, Problem>:: lhs(const tk::Fields& geoElem,
tk::Fields& l) const
Parameters | |
---|---|
geoElem in | Element geometry array |
l in/out | Block diagonal mass matrix |
Compute the left hand side block-diagonal mass matrix
template<class Physics, class Problem>
void inciter:: fv:: MultiMat<Physics, Problem>:: updatePrimitives(const tk::Fields& unk,
tk::Fields& prim,
std::size_t nielem) const
Parameters | |
---|---|
unk in | Array of unknowns |
prim in/out | Array of primitives |
nielem in | Number of internal elements |
Update the primitives for this PDE system This function computes and stores the dofs for primitive quantities, which are required for obtaining reconstructed states used in the Riemann solver. See /PDE/Riemann/AUSM.hpp, where the normal velocity for advection is calculated from independently reconstructed velocities.
template<class Physics, class Problem>
void inciter:: fv:: MultiMat<Physics, Problem>:: cleanTraceMaterial(tk:: real t,
const tk::Fields& geoElem,
tk::Fields& unk,
tk::Fields& prim,
std::size_t nielem) const
Parameters | |
---|---|
t in | Physical time |
geoElem in | Element geometry array |
unk in/out | Array of unknowns |
prim in/out | Array of primitives |
nielem in | Number of internal elements |
Clean up the state of trace materials for this PDE system This function cleans up the state of materials present in trace quantities in each cell. Specifically, the state of materials with very low volume-fractions in a cell is replaced by the state of the material which is present in the largest quantity in that cell. This becomes necessary when shocks pass through cells which contain a very small amount of material. The state of that tiny material might become unphysical and cause solution to diverge; thus requiring such a "reset".
template<class Physics, class Problem>
void inciter:: fv:: MultiMat<Physics, Problem>:: reconstruct(const tk::Fields& geoElem,
const inciter:: FaceData& fd,
const std::map<std::size_t, std::vector<std::size_t>>& esup,
const std::vector<std::size_t>& inpoel,
const tk:: UnsMesh:: Coords& coord,
tk::Fields& U,
tk::Fields& P) const
Parameters | |
---|---|
geoElem in | Element geometry array |
fd in | Face connectivity and boundary conditions object |
esup in | Elements-surrounding-nodes connectivity |
inpoel in | Element-node connectivity |
coord in | Array of nodal coordinates |
U in/out | Solution vector at recent time step |
P in/out | Vector of primitives at recent time step |
Reconstruct second-order solution from first-order
template<class Physics, class Problem>
void inciter:: fv:: MultiMat<Physics, Problem>:: limit(const tk::Fields& geoFace,
const inciter:: FaceData& fd,
const std::map<std::size_t, std::vector<std::size_t>>& esup,
const std::vector<std::size_t>& inpoel,
const tk:: UnsMesh:: Coords& coord,
const std::vector<int>& srcFlag,
tk::Fields& U,
tk::Fields& P) const
Parameters | |
---|---|
geoFace in | Face geometry array |
fd in | Face connectivity and boundary conditions object |
esup in | Elements-surrounding-nodes connectivity |
inpoel in | Element-node connectivity |
coord in | Array of nodal coordinates |
srcFlag in | Whether the energy source was added |
U in/out | Solution vector at recent time step |
P in/out | Vector of primitives at recent time step |
Limit second-order solution, and primitive quantities separately
template<class Physics, class Problem>
void inciter:: fv:: MultiMat<Physics, Problem>:: CPL(const tk::Fields& prim,
const tk::Fields& geoElem,
const std::vector<std::size_t>& inpoel,
const tk:: UnsMesh:: Coords& coord,
tk::Fields& unk,
std::size_t nielem) const
Parameters | |
---|---|
prim in | Array of primitive variables |
geoElem in | Element geometry array |
inpoel in | Element-node connectivity |
coord in | Array of nodal coordinates |
unk in/out | Array of conservative variables |
nielem in | Number of internal elements |
Apply CPL to the conservative variable solution for this PDE system This function applies CPL to obtain consistent dofs for conservative quantities based on the limited primitive quantities. See Pandare et al. (2023). On the Design of Stable, Consistent, and Conservative High-Order Methods for Multi-Material Hydrodynamics. J Comp Phys, 112313.
template<class Physics, class Problem>
void inciter:: fv:: MultiMat<Physics, Problem>:: rhs(tk:: real t,
const tk::Fields& geoFace,
const tk::Fields& geoElem,
const inciter:: FaceData& fd,
const std::vector<std::size_t>& inpoel,
const tk:: UnsMesh:: Coords& coord,
const std::unordered_map<std::size_t, std::set<std::size_t>>& elemblkid,
const tk::Fields& U,
const tk::Fields& P,
tk::Fields& R,
std::vector<int>& srcFlag) const
Parameters | |
---|---|
t in | Physical time |
geoFace in | Face geometry array |
geoElem in | Element geometry array |
fd in | Face connectivity and boundary conditions object |
inpoel in | Element-node connectivity |
coord in | Array of nodal coordinates |
elemblkid in | Element ids associated with mesh block ids where user ICs are set |
U in | Solution vector at recent time step |
P in | Primitive vector at recent time step |
R in/out | Right-hand side vector computed |
srcFlag in/out | Whether the energy source was added |
Compute right hand side
template<class Physics, class Problem>
tk:: real inciter:: fv:: MultiMat<Physics, Problem>:: dt(const inciter:: FaceData&,
const tk::Fields&,
const tk::Fields& geoElem,
const tk::Fields& U,
const tk::Fields& P,
const std::size_t nielem,
const std::vector<int>& srcFlag,
std::vector<tk:: real>& local_dte) const
Compute the minimum time step size.
Parameters | |
---|---|
geoElem in | Element geometry array |
U in | Solution vector at recent time step |
P in | Vector of primitive quantities at recent time step |
nielem in | Number of internal elements |
srcFlag in | Whether the energy source was added |
local_dte in/out | Time step size for each element (for local time stepping) |
Returns | Minimum time step size |
The allowable dt is calculated by looking at the maximum wave-speed in elements surrounding each face, times the area of that face. Once the maximum of this quantity over the mesh is determined, the volume of each cell is divided by this quantity. A minimum of this ratio is found over the entire mesh, which gives the allowable dt.
template<class Physics, class Problem>
std::array<std::array<tk:: real, 4>, 3> inciter:: fv:: MultiMat<Physics, Problem>:: velocity(const tk::Fields& U,
const std::array<std::vector<tk:: real>, 3>&,
const std::array<std::size_t, 4>& N) const
Parameters | |
---|---|
U in | Solution vector at recent time step |
N in | Element node indices |
Returns | Array of the four values of the velocity field |
Extract the velocity field at cell nodes. Currently unused.
template<class Physics, class Problem>
std::map<std::string, tk:: GetVarFn> inciter:: fv:: MultiMat<Physics, Problem>:: OutVarFn() const
Returns | Map that associates user-specified strings to functions that compute relevant quantities to be output to file |
---|
Return a map that associates user-specified strings to functions
template<class Physics, class Problem>
std::vector<std::string> inciter:: fv:: MultiMat<Physics, Problem>:: analyticFieldNames() const
Returns | Vector of strings labelling analytic fields output in file |
---|
Return analytic field names to be output to file
template<class Physics, class Problem>
std::vector<std::string> inciter:: fv:: MultiMat<Physics, Problem>:: surfNames() const
Returns | Vector of strings labelling surface fields output in file |
---|
Return surface field names to be output to file
template<class Physics, class Problem>
std::vector<std::string> inciter:: fv:: MultiMat<Physics, Problem>:: histNames() const
Returns | Vector of strings labelling time history fields output in file |
---|
Return time history field names to be output to file
template<class Physics, class Problem>
std::vector<std::vector<tk:: real>> inciter:: fv:: MultiMat<Physics, Problem>:: histOutput(const std::vector<HistData>& h,
const std::vector<std::size_t>& inpoel,
const tk:: UnsMesh:: Coords& coord,
const tk::Fields& U,
const tk::Fields& P) const
Parameters | |
---|---|
h in | History point data |
inpoel in | Element-node connectivity |
coord in | Array of nodal coordinates |
U in | Array of unknowns |
P in | Array of primitive quantities |
Returns | Vector of time history output of bulk flow quantities (density, velocity, total energy, pressure, and volume fraction) evaluated at time history points |
Return time history field output evaluated at time history points
template<class Physics, class Problem>
std::vector<std::string> inciter:: fv:: MultiMat<Physics, Problem>:: names() const
Returns | Vector of strings labelling integral variables output |
---|
Return names of integral variables to be output to diagnostics file
template<class Physics, class Problem>
std::vector<tk:: real> inciter:: fv:: MultiMat<Physics, Problem>:: analyticSolution(tk:: real xi,
tk:: real yi,
tk:: real zi,
tk:: real t) const
Parameters | |
---|---|
xi in | X-coordinate at which to evaluate the analytic solution |
yi in | Y-coordinate at which to evaluate the analytic solution |
zi in | Z-coordinate at which to evaluate the analytic solution |
t in | Physical time at which to evaluate the analytic solution |
Returns | Vector of analytic solution at given location and time |
Return analytic solution (if defined by Problem) at xi, yi, zi, t
template<class Physics, class Problem>
std::vector<tk:: real> inciter:: fv:: MultiMat<Physics, Problem>:: solution(tk:: real xi,
tk:: real yi,
tk:: real zi,
tk:: real t) const
Parameters | |
---|---|
xi in | X-coordinate at which to evaluate the analytic solution |
yi in | Y-coordinate at which to evaluate the analytic solution |
zi in | Z-coordinate at which to evaluate the analytic solution |
t in | Physical time at which to evaluate the analytic solution |
Returns | Vector of analytic solution at given location and time |
Return analytic solution for conserved variables
template<class Physics, class Problem>
tk:: real inciter:: fv:: MultiMat<Physics, Problem>:: sp_totalenergy(std::size_t e,
const tk::Fields& unk) const
Parameters | |
---|---|
e in | Element id for which total energy is required |
unk in | Vector of conserved quantities |
Returns | Cell-averaged specific total energy for given element |
Return cell-averaged specific total energy for an element
template<class Physics, class Problem>
void inciter:: fv:: MultiMat<Physics, Problem>:: soundspeed(std::size_t nielem,
const tk::Fields& U,
const tk::Fields& P,
std::vector<tk:: real>& ss) const
Parameters | |
---|---|
nielem in | Number of internal elements |
U in | Solution vector at recent time step |
P in | Primitive vector at recent time step |
ss in/out | Sound speed vector |
Compute relevant sound speed for output