ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_ShocDriver.H File Reference
#include "ERF_ShocDiagnostics.H"
#include "ERF_ShocTypes.H"
#include "ERF_ShocPreprocess.H"
#include "ERF_ShocColumnData.H"
#include <AMReX_BoxArray.H>
#include <AMReX_Geometry.H>
#include <AMReX_MultiFab.H>
#include <memory>
Include dependency graph for ERF_ShocDriver.H:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  ShocDriver
 

Functions

bool shoc_boxarray_spans_full_height (const amrex::BoxArray &ba, const amrex::Box &domain)
 
bool shoc_layout_requires_number_closure (const MoistureComponentIndices &indices, int ncomp) noexcept
 
bool shoc_driver_state_update_layout_supported (const MoistureComponentIndices &indices, int ncomp, std::string &error_message)
 

Function Documentation

◆ shoc_boxarray_spans_full_height()

bool shoc_boxarray_spans_full_height ( const amrex::BoxArray &  ba,
const amrex::Box &  domain 
)

◆ shoc_driver_state_update_layout_supported()

bool shoc_driver_state_update_layout_supported ( const MoistureComponentIndices indices,
int  ncomp,
std::string &  error_message 
)
inline
29 {
30  if (!shoc_layout_requires_number_closure(indices, ncomp)) {
31  return true;
32  }
33 
34  error_message =
35  "Native SHOC state_update does not yet support number-aware microphysics layouts with cloud/ice number concentrations. A number closure is required before SHOC can update cloud mass in these layouts.";
36  return false;
37 }
bool shoc_layout_requires_number_closure(const MoistureComponentIndices &indices, int ncomp) noexcept
Definition: ERF_ShocDriver.H:19

Referenced by ShocDriver::advance().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ shoc_layout_requires_number_closure()

bool shoc_layout_requires_number_closure ( const MoistureComponentIndices indices,
int  ncomp 
)
inlinenoexcept
21 {
22  return shoc_valid_comp(indices.nc, ncomp) || shoc_valid_comp(indices.ni, ncomp);
23 }
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool shoc_valid_comp(int comp, int ncomp)
Definition: ERF_ShocTypes.H:226
int nc
cloud liquid water number
Definition: ERF_DataStruct.H:244
int ni
cloud ice number
Definition: ERF_DataStruct.H:245

Referenced by shoc_driver_state_update_layout_supported().

Here is the call graph for this function:
Here is the caller graph for this function: