#include <REMORA.H>
#include <REMORA_Constants.H>
#include <REMORA_prob_common.H>
#include <REMORA_DataStruct.H>

Include dependency graph for REMORA_init_from_netcdf.cpp:

Functions
void	read_data_from_netcdf (int, const Box &domain, const std::string &fname, FArrayBox &NC_temp_fab, FArrayBox &NC_salt_fab, FArrayBox &NC_xvel_fab, FArrayBox &NC_yvel_fab, FArrayBox &NC_ubar_fab, FArrayBox &NC_vbar_fab)
	helper function for reading in initial state data from netcdf

void	read_masks_from_netcdf (int, const Box &domain, const std::string &fname, FArrayBox &NC_mskr_fab, FArrayBox &NC_msku_fab, FArrayBox &NC_mskv_fab)
	helper function for reading in land-sea masks from netcdf

Real	read_bdry_from_netcdf (const Box &domain, const std::string &fname, Vector< Vector< FArrayBox > > &bdy_data_xlo, Vector< Vector< FArrayBox > > &bdy_data_xhi, Vector< Vector< FArrayBox > > &bdy_data_ylo, Vector< Vector< FArrayBox > > &bdy_data_yhi, int &width, amrex::Real &start_bdy_time, std::string bdry_time_varname, amrex::GpuArray< amrex::GpuArray< bool, AMREX_SPACEDIM *2 >, BdyVars::NumTypes+1 > &)
	helper function for reading boundary data from netcdf

void	init_state_from_netcdf (int lev, FArrayBox &temp_fab, FArrayBox &salt_fab, FArrayBox &x_vel_fab, FArrayBox &y_vel_fab, FArrayBox &ubar_fab, FArrayBox &vbar_fab, const Vector< FArrayBox > &NC_temp_fab, const Vector< FArrayBox > &NC_salt_fab, const Vector< FArrayBox > &NC_xvel_fab, const Vector< FArrayBox > &NC_yvel_fab, const Vector< FArrayBox > &NC_ubar_fab, const Vector< FArrayBox > &NC_vbar_fab)
	helper function to initialize state from netcdf

void	read_bathymetry_from_netcdf (int lev, const Box &domain, const std::string &fname, FArrayBox &NC_h_fab, FArrayBox &NC_pm_fab, FArrayBox &NC_pn_fab, FArrayBox &NC_xr_fab, FArrayBox &NC_yr_fab, FArrayBox &NC_xu_fab, FArrayBox &NC_yu_fab, FArrayBox &NC_xv_fab, FArrayBox &NC_yv_fab, FArrayBox &NC_xp_fab, FArrayBox &NC_yp_fab)
	helper function to read bathymetry from netcdf

void	read_coriolis_from_netcdf (int lev, const Box &domain, const std::string &fname, FArrayBox &NC_fcor_fab)
	helper function to read coriolis factor from netcdf

void	read_zeta_from_netcdf (int lev, const Box &domain, const std::string &fname, FArrayBox &NC_zeta_fab)
	helper function to read sea surface height from netcdf

void	read_clim_nudg_coeff_from_netcdf (int lev, const Box &domain, const std::string &fname, bool do_m2_clim_nudg, bool do_m3_clim_nudg, bool do_temp_clim_nudg, bool do_salt_clim_nudg, FArrayBox &NC_M2NC_fab, FArrayBox &NC_M3NC_fab, FArrayBox &NC_TempNC_fab, FArrayBox &NC_SaltNC_fab)
	helper function to read climatology nudging from netcdf

void	read_vec_from_netcdf (int lev, const std::string &fname, const std::string &field_name, amrex::Vector< int > &vec_dat)
	helper function to read in vector of data from netcdf

Function Documentation

◆ init_state_from_netcdf()

void init_state_from_netcdf	(	int	,
		FArrayBox &	temp_fab,
		FArrayBox &	salt_fab,
		FArrayBox &	x_vel_fab,
		FArrayBox &	y_vel_fab,
		FArrayBox &	ubar_fab,
		FArrayBox &	vbar_fab,
		const Vector< FArrayBox > &	NC_temp_fab,
		const Vector< FArrayBox > &	NC_salt_fab,
		const Vector< FArrayBox > &	NC_xvel_fab,
		const Vector< FArrayBox > &	NC_yvel_fab,
		const Vector< FArrayBox > &	NC_ubar_fab,
		const Vector< FArrayBox > &	NC_vbar_fab
	)

helper function to initialize state from netcdf

Helper function to initialize state and velocity data in a Fab from a REMORAdataset.

Parameters

lev	Integer specifying current level
state_fab	FArrayBox object holding the state data we initialize
temp_fab	FArrayBox object holding the temperature data we initialize
salt_fab	FArrayBox object holding the salt data we initialize
x_vel_fab	FArrayBox object holding the x-velocity data we initialize
y_vel_fab	FArrayBox object holding the y-velocity data we initialize
ubar_fab	FArrayBox object holding the ubar data we initialize
vbar_fab	FArrayBox object holding the vbar data we initialize
zeta_fab	FArrayBox object holding the zeta data we initialize
NC_temp_fab	Vector of FArrayBox objects with the REMORA dataset specifying temperature
NC_salt_fab	Vector of FArrayBox objects with the REMORA dataset specifying salinity
NC_xvel_fab	Vector of FArrayBox objects with the REMORA dataset specifying x-velocity
NC_yvel_fab	Vector of FArrayBox objects with the REMORA dataset specifying y-velocity
NC_ubar_fab	Vector of FArrayBox objects with the REMORA dataset specifying ubar
NC_vbar_fab	Vector of FArrayBox objects with the REMORA dataset specifying vbar
NC_zeta_fab	Vector of FArrayBox objects with the REMORA dataset specifying zeta

Definition at line 466 of file REMORA_init_from_netcdf.cpp.

Referenced by REMORA::init_data_from_netcdf().

Here is the caller graph for this function:

◆ read_bathymetry_from_netcdf()

void read_bathymetry_from_netcdf	(	int	lev,
		const Box &	domain,
		const std::string &	fname,
		FArrayBox &	NC_h_fab,
		FArrayBox &	NC_pm_fab,
		FArrayBox &	NC_pn_fab,
		FArrayBox &	NC_xr_fab,
		FArrayBox &	NC_yr_fab,
		FArrayBox &	NC_xu_fab,
		FArrayBox &	NC_yu_fab,
		FArrayBox &	NC_xv_fab,
		FArrayBox &	NC_yv_fab,
		FArrayBox &	NC_xp_fab,
		FArrayBox &	NC_yp_fab
	)

helper function to read bathymetry from netcdf

Parameters

lev	level of data to read
domain	simulation domain
fname	file name to read from
NC_h_fab	container for bathymetry data
NC_pm_fab	container for pm data
NC_pn_fab	container for pn data
NC_xr_fab	container for x_rho data
NC_yr_fab	container for y_rho data
NC_xu_fab	container for x_u data
NC_yu_fab	container for y_u data
NC_xv_fab	container for x_v data
NC_yv_fab	container for y_v data
NC_xp_fab	container for x_p data
NC_yp_fab	container for y_p data

Definition at line 85 of file REMORA_ReadFromInitNetcdf.cpp.

Referenced by REMORA::init_bathymetry_from_netcdf().

Here is the caller graph for this function:

◆ read_bdry_from_netcdf()

Real read_bdry_from_netcdf	(	const Box &	domain,
		const std::string &	fname,
		Vector< Vector< FArrayBox > > &	bdy_data_xlo,
		Vector< Vector< FArrayBox > > &	bdy_data_xhi,
		Vector< Vector< FArrayBox > > &	bdy_data_ylo,
		Vector< Vector< FArrayBox > > &	bdy_data_yhi,
		int &	width,
		amrex::Real &	start_bdy_time,
		std::string	bdry_time_varname,
		amrex::GpuArray< amrex::GpuArray< bool, AMREX_SPACEDIM *2 >, BdyVars::NumTypes+1 > &
	)

helper function for reading boundary data from netcdf

Referenced by REMORA::init_bdry_from_netcdf().

Here is the caller graph for this function:

◆ read_clim_nudg_coeff_from_netcdf()

void read_clim_nudg_coeff_from_netcdf	(	int	lev,
		const Box &	domain,
		const std::string &	fname,
		bool	do_m2_clim_nudg,
		bool	do_m3_clim_nudg,
		bool	do_temp_clim_nudg,
		bool	do_salt_clim_nudg,
		FArrayBox &	NC_M2NC_fab,
		FArrayBox &	NC_M3NC_fab,
		FArrayBox &	NC_TempNC_fab,
		FArrayBox &	NC_SaltNC_fab
	)

helper function to read climatology nudging from netcdf

Parameters

lev	level of data to read
domain	simulation domain
fname	file name to read from
do_m2_clim_nudg	whether to do 2d momentum climatology nudging
do_m3_clim_nudg	whether to do 3d momentum climatology nudging
do_temp_clim_nudg	whether to do temperature climatology nudging
do_salt_clim_nudg	whether to do salinity climatology nudging
NC_M2NC_fab	container for 2d momentum climatology data
NC_M3NC_fab	container for 3d momentum climatology data
NC_TempNC_fab	container for temperature climatology data
NC_SaltNC_fab	container for salinity climatology data

Definition at line 185 of file REMORA_ReadFromInitNetcdf.cpp.

Referenced by REMORA::init_clim_nudg_coeff_from_netcdf().

Here is the caller graph for this function:

◆ read_coriolis_from_netcdf()

void read_coriolis_from_netcdf	(	int	lev,
		const Box &	domain,
		const std::string &	fname,
		FArrayBox &	NC_fcor_fab
	)

helper function to read coriolis factor from netcdf

Parameters

lev	level of data to read
domain	simulation domain
fname	file name to read from
NC_fcor_fab	container for Coriolis parameter data

Definition at line 124 of file REMORA_ReadFromInitNetcdf.cpp.

Referenced by REMORA::init_coriolis_from_netcdf().

Here is the caller graph for this function:

◆ read_data_from_netcdf()

void read_data_from_netcdf	(	int	,
		const Box &	domain,
		const std::string &	fname,
		FArrayBox &	NC_temp_fab,
		FArrayBox &	NC_salt_fab,
		FArrayBox &	NC_xvel_fab,
		FArrayBox &	NC_yvel_fab,
		FArrayBox &	NC_ubar_fab,
		FArrayBox &	NC_vbar_fab
	)

helper function for reading in initial state data from netcdf

Parameters

lev	level of data to read
domain	simulation domain
fname	file name to read from
NC_temp_fab	container for temperature data
NC_salt_fab	container for salinity data
NC_u_fab	container for u velocity data
NC_v_fab	container for v velocity data
NC_ubar_fab	container for u_bar velocity data
NC_vbar_fab	container for v_bar velocity data

Definition at line 20 of file REMORA_ReadFromInitNetcdf.cpp.

Referenced by REMORA::init_data_from_netcdf().

Here is the caller graph for this function:

◆ read_masks_from_netcdf()

void read_masks_from_netcdf	(	int	,
		const Box &	domain,
		const std::string &	fname,
		FArrayBox &	NC_mskr_fab,
		FArrayBox &	NC_msku_fab,
		FArrayBox &	NC_mskv_fab
	)

helper function for reading in land-sea masks from netcdf

Parameters

lev	level of data to read
domain	simulation domain
fname	file name to read from
NC_mskr_fab	container for rho-point land/sea mask data
NC_msku_fab	container for u-point land/sea mask data
NC_mskv_fab	container for v-point land/sea mask data