#include <AMReX_REAL.H>
#include <AMReX_Arena.H>
#include <AMReX_Extension.H>
#include <AMReX_GpuQualifiers.H>

Include dependency graph for REMORA_IndexDefines.H:

This graph shows which files directly or indirectly include this file:

Namespaces
namespace	BCVars
	Boundary fill types.

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

namespace	AtmosState
	Index constants for driver_atmos_state_from_driver and the matching atmospheric forcing MultiFab vector passed to REMORA::ApplyAtmosphericStates.

namespace	AtmosFluxes
	Index constants for the driver ATM->OCN flux-passing active view.

namespace	BulkFlux
	Index constants for SolverChoice::bulk_flux_type.

namespace	REMORABCType

Macros
#define	Temp_comp 0

#define	Salt_comp 1

#define	Tracer_comp 2

#define	NAT Tracer_comp

#define	NGROW 2

Enumerations
enum	{ AtmosState::Uwind = 0 , AtmosState::Vwind , AtmosState::Pair , AtmosState::Qair , AtmosState::Tair , AtmosState::Cloud , AtmosState::Rain , AtmosState::SWrad , AtmosState::LWrad , AtmosState::NumTypes }

enum	{ AtmosFluxes::TauX = 0 , AtmosFluxes::TauY , AtmosFluxes::SHflux , AtmosFluxes::LHflux , AtmosFluxes::SWrad , AtmosFluxes::LWrad , AtmosFluxes::Rain , AtmosFluxes::Evap , AtmosFluxes::NumTypes }

enum class	BulkForcingType { constant , analytic , netcdf , computed }
	Source type for bulk-flux atmospheric forcing variables. More...

enum	{ BulkFlux::Uwind = 0 , BulkFlux::Vwind , BulkFlux::Pair , BulkFlux::Qair , BulkFlux::Tair , BulkFlux::Cloud , BulkFlux::Rain , BulkFlux::SWrad , BulkFlux::LWrad , BulkFlux::EminusP , BulkFlux::NumTypes }

enum struct	REMORA_BC { symmetry , inflow , outflow , no_slip_wall , slip_wall , periodic , clamped , chapman , flather , orlanski_rad , orlanski_rad_nudge , undefined }

enum	REMORABCType::mathematicalBndryTypes : int { REMORABCType::bogus = -666 , REMORABCType::reflect_odd = -1 , REMORABCType::int_dir = 0 , REMORABCType::reflect_even = 1 , REMORABCType::foextrap = 2 , REMORABCType::ext_dir = 3 , REMORABCType::clamped = 4 , REMORABCType::chapman = 5 , REMORABCType::flather = 6 , REMORABCType::orlanski_rad = 7 , REMORABCType::orlanski_rad_nudge = 8 }

Functions
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int	akt_comp (int icomp) noexcept

int	BCVars::xvel_bc (int ncons) noexcept

int	BCVars::yvel_bc (int ncons) noexcept

int	BCVars::zvel_bc (int ncons) noexcept

int	BCVars::ubar_bc (int ncons) noexcept

int	BCVars::vbar_bc (int ncons) noexcept

int	BCVars::zeta_bc (int ncons) noexcept

int	BCVars::tke_bc (int ncons) noexcept

int	BCVars::foextrap_periodic_bc (int ncons) noexcept

int	BCVars::foextrap_bc (int ncons) noexcept

int	BCVars::u2d_simple_bc (int ncons) noexcept

int	BCVars::v2d_simple_bc (int ncons) noexcept

int	BCVars::NumTypes (int ncons) noexcept

int	BdyVars::cons (int icomp) noexcept

int	BdyVars::ubar (int ncons) noexcept

int	BdyVars::vbar (int ncons) noexcept

int	BdyVars::zeta (int ncons) noexcept

int	BdyVars::NumTypes (int ncons) noexcept

Variables
static constexpr int	BCVars::cons_bc = 0

static constexpr int	BCVars::Temp_bc_comp = 0

static constexpr int	BCVars::Salt_bc_comp = 1

static constexpr int	BCVars::Scalar_bc_comp = 2

static constexpr int	BdyVars::null = -1

static constexpr int	BdyVars::u = 0

static constexpr int	BdyVars::v = 1

static constexpr int	BdyVars::t = 2
	cons component Temp_comp

static constexpr int	BdyVars::s = 3
	cons component Salt_comp

Macro Definition Documentation

◆ NAT

#define NAT Tracer_comp

Definition at line 17 of file REMORA_IndexDefines.H.

◆ NGROW

#define NGROW 2

Definition at line 30 of file REMORA_IndexDefines.H.

◆ Salt_comp

#define Salt_comp 1

Definition at line 11 of file REMORA_IndexDefines.H.

◆ Temp_comp

#define Temp_comp 0

Definition at line 10 of file REMORA_IndexDefines.H.

◆ Tracer_comp

#define Tracer_comp 2

Definition at line 12 of file REMORA_IndexDefines.H.

Enumeration Type Documentation

◆ BulkForcingType

enum class BulkForcingType

strong

Source type for bulk-flux atmospheric forcing variables.

computed is used for diagnostics/parameterizations that are evaluated by REMORA rather than prescribed as an input field, e.g. Berliand longwave or bulk evaporation minus precipitation.

Enumerator
constant
analytic
netcdf
computed

Definition at line 135 of file REMORA_IndexDefines.H.

◆ REMORA_BC

enum struct REMORA_BC

strong

Enumerator
symmetry
inflow
outflow
no_slip_wall
slip_wall
periodic
clamped
chapman
flather
orlanski_rad
orlanski_rad_nudge
undefined

Definition at line 161 of file REMORA_IndexDefines.H.

Function Documentation

◆ akt_comp()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int akt_comp ( int icomp )

noexcept

The vertical diffusivity component that cons component icomp is mixed with.

Akt is stored for the active tracers only, and every passive tracer – dye and biology alike – mixes with the salinity coefficient. This is ROMS's ltrc=MIN(itrc,NAT) in pre_step3d and step3d_t, and it is why vec_Akt has NAT components rather than ncons. Horizontal diffusivity is a separate story: tnu2 really is per tracer.

Definition at line 28 of file REMORA_IndexDefines.H.

Referenced by REMORA::advance_3d(), and REMORA::prestep().

Here is the call graph for this function:

Here is the caller graph for this function:

Namespaces

Macros

Enumerations

Functions

Variables