BdyVars Namespace Reference

These are only for the variables read in from netcdf boundary condition files. More...

Functions
int	cons (int icomp) noexcept
int	ubar (int ncons) noexcept
int	vbar (int ncons) noexcept
int	zeta (int ncons) noexcept
int	NumTypes (int ncons) noexcept

Variables
static constexpr int	null = -1
static constexpr int	u = 0
static constexpr int	v = 1
static constexpr int	t = 2
	cons component Temp_comp
static constexpr int	s = 3
	cons component Salt_comp

Detailed Description

These are only for the variables read in from netcdf boundary condition files.

The cell-centered tracers occupy a contiguous block of slots starting at t, laid out in the same order as the components of the cons MultiFab. So slot t is temp, slot t+1 is salt, and slot t+n is cons component n for every additional scalar (passive tracers, biology tracers). Use cons(icomp) rather than hardcoding this, and note that the logic in fill_from_bdyfiles relies on the block being contiguous and in component order.

Like BCVars, everything above the tracer block is a function of ncons rather than a compile-time constant. With ncons == 2 these reduce to the historical fixed values (ubar 4, vbar 5, zeta 6, NumTypes 7).

Function Documentation

cons()

int BdyVars::cons ( int  icomp )

inlinenoexcept

Definition at line 76 of file REMORA_IndexDefines.H.

Referenced by REMORA::advance_3d(), REMORA::bdy_cons(), REMORA::fill_from_bdyfiles(), REMORA::init_bcs(), REMORA::init_bdry_from_netcdf(), REMORA::init_clim_nudg_coeff(), REMORA::init_clim_nudg_coeff_from_netcdf(), SolverChoice::init_params(), REMORA::init_stuff(), REMORA::ReadParameters(), and REMORA::resize_stuff().

Here is the call graph for this function:

Here is the caller graph for this function:

NumTypes()

int BdyVars::NumTypes ( int  ncons )

inlinenoexcept

Definition at line 80 of file REMORA_IndexDefines.H.

Referenced by SolverChoice::init_params(), REMORA::num_bdy_vars(), and REMORA::ReadParameters().

Here is the caller graph for this function:

ubar()

int BdyVars::ubar ( int  ncons )

inlinenoexcept

Definition at line 77 of file REMORA_IndexDefines.H.

Referenced by REMORA::bdy_ubar(), SolverChoice::init_params(), and REMORA::ReadParameters().

Here is the caller graph for this function:

vbar()

int BdyVars::vbar ( int  ncons )

inlinenoexcept

Definition at line 78 of file REMORA_IndexDefines.H.

Referenced by REMORA::bdy_vbar(), SolverChoice::init_params(), and REMORA::ReadParameters().

Here is the caller graph for this function:

zeta()

int BdyVars::zeta ( int  ncons )

inlinenoexcept

Definition at line 79 of file REMORA_IndexDefines.H.

Referenced by REMORA::bdy_zeta(), SolverChoice::init_params(), and REMORA::ReadParameters().

Here is the caller graph for this function:

Variable Documentation

null

constexpr int BdyVars::null = -1

staticconstexpr

Definition at line 70 of file REMORA_IndexDefines.H.

Referenced by REMORA::advance_3d_ml(), REMORA::ErrorEst(), REMORA::FillCoarsePatchMap(), REMORA::FillPatch(), REMORA::gls_corrector(), REMORA::gls_prestep(), REMORA::init_bathymetry_from_netcdf(), REMORA::init_grid_vars_from_netcdf(), REMORA::init_only(), REMORA::InitData(), REMORA::MakeNewLevelFromCoarse(), REMORA::RemakeLevel(), REMORA::set_analytic_vmix(), REMORA::set_bathymetry(), REMORA::set_bathymetry_averaged_down(), REMORA::set_grid_vars_averaged_down(), REMORA::set_hmixcoef(), REMORA::set_smflux(), REMORA::set_surface_state(), REMORA::setup_step(), REMORA::timeStepML(), and REMORA::WritePlotFile().

s

constexpr int BdyVars::s = 3

staticconstexpr

cons component Salt_comp

Definition at line 74 of file REMORA_IndexDefines.H.

t

constexpr int BdyVars::t = 2

staticconstexpr

cons component Temp_comp

Definition at line 73 of file REMORA_IndexDefines.H.

Referenced by REMORA::advance_3d(), cons(), REMORA::ErrorEst(), REMORA::fill_from_bdyfiles(), REMORA::init_only(), REMORA::InitData(), REMORA::MakeNewLevelFromCoarse(), NumTypes(), REMORA::RemakeLevel(), REMORA::set_init_data_averaged_down(), REMORA::setup_step(), ubar(), vbar(), REMORA::WritePlotFile(), and zeta().

u

constexpr int BdyVars::u = 0

staticconstexpr

Definition at line 71 of file REMORA_IndexDefines.H.

Referenced by REMORA::advance_3d(), REMORA::ErrorEst(), REMORA::init_bcs(), REMORA::init_bdry_from_netcdf(), REMORA::init_clim_nudg_coeff(), REMORA::init_clim_nudg_coeff_from_netcdf(), REMORA::init_only(), SolverChoice::init_params(), REMORA::init_stuff(), REMORA::InitData(), REMORA::MakeNewLevelFromCoarse(), REMORA::ReadParameters(), REMORA::RemakeLevel(), REMORA::resize_stuff(), REMORA::set_init_data_averaged_down(), REMORA::setup_step(), REMORA::timeStepML(), and REMORA::WritePlotFile().

v

constexpr int BdyVars::v = 1

staticconstexpr

Definition at line 72 of file REMORA_IndexDefines.H.

Referenced by REMORA::advance_3d(), REMORA::ErrorEst(), REMORA::init_bcs(), REMORA::init_bdry_from_netcdf(), REMORA::init_clim_nudg_coeff(), REMORA::init_clim_nudg_coeff_from_netcdf(), REMORA::init_only(), SolverChoice::init_params(), REMORA::init_stuff(), REMORA::InitData(), REMORA::MakeNewLevelFromCoarse(), REMORA::ReadParameters(), REMORA::RemakeLevel(), REMORA::resize_stuff(), REMORA::set_init_data_averaged_down(), REMORA::setup_step(), REMORA::timeStepML(), and REMORA::WritePlotFile().