AMReX-Hydro
AMReX-based hydro routines for low Mach number flows
Loading...
Searching...
No Matches
hydro_plic.H
Go to the documentation of this file.
1/**
2 * \file hydro_plic.H
3 *
4 * Geometric volume-of-fluid transport with a piecewise-linear interface calculation (PLIC), for any
5 * AMReX-based solver.
6 *
7 * The interface in each mixed cell is a plane, fitted to the volume fractions F (the liquid fraction
8 * of each cell) around it. The reconstruction, how the normal of the plane is computed, is selected
9 * by name: "youngs", "myc" or "myc_height". Like Godunov, MOL and BDS, the library provides spatial
10 * operators and leaves the update, the ghost cells and the synchronization of the levels to the
11 * solver.
12 *
13 * Requires Cartesian coordinates, and has no embedded boundary support.
14 *
15 * \addtogroup PLIC
16 * @{
17 */
18
19#ifndef HYDRO_PLIC_H
20#define HYDRO_PLIC_H
21
22#include <hydro_plic_K.H>
23
24#include <AMReX_Geometry.H>
25#include <AMReX_MultiFab.H>
26
27#include <string>
28
29namespace PLIC {
30
31/**
32 * \brief The ghost cells of F that the operators of this library read, with the given
33 * reconstruction. Allocate and fill at least this many.
34 */
35[[nodiscard]] int nGrowF (std::string const& reconstruction);
36
37/**
38 * \brief Abort unless the mesh is supported: Cartesian coordinates and no embedded boundaries.
39 */
40void CheckMesh (amrex::MultiFab const& F, amrex::Geometry const& geom);
41
42/**
43 * \brief Fit the plane of each mixed cell, and zero the others.
44 *
45 * \param plane 4 components (m_x, m_y, m_z, alpha), in unit-cube cell coordinates, with the
46 * liquid on the side m.x <= alpha and sum|m| = 1
47 * \param F volume fraction, with its ghost cells filled
48 * \param ngrow ghost layers of plane to fit
49 * \param reconstruction "youngs", "myc" or "myc_height"
50 */
51void FitPlanes (amrex::MultiFab& plane, amrex::MultiFab const& F, int ngrow,
52 std::string const& reconstruction);
53
54} // namespace PLIC
55
56#endif
57/** @}*/
Definition hydro_plic.cpp:9
void FitPlanes(amrex::MultiFab &plane, amrex::MultiFab const &F, int ngrow, std::string const &reconstruction)
Fit the plane of each mixed cell, and zero the others.
Definition hydro_plic_reconstruction.cpp:50
int nGrowF(std::string const &reconstruction)
The ghost cells of F that the operators of this library read, with the given reconstruction....
Definition hydro_plic_reconstruction.cpp:45
void CheckMesh(amrex::MultiFab const &F, amrex::Geometry const &geom)
Abort unless the mesh is supported: Cartesian coordinates and no embedded boundaries.
Definition hydro_plic.cpp:12