#include <REMORA_NCTimeSeriesRiver.H>

Collaboration diagram for NCTimeSeriesRiver:

[legend]

Public Member Functions
	NCTimeSeriesRiver (const amrex::Vector< std::string > &a_file_names, const std::string a_field_name, const std::string a_time_name, const int a_nz, double a_time_ref, const int a_use_vert_integ=0, const int a_is_transport=0)

void	Initialize ()

void	update_interpolated_to_time (double time)
	Calculate interpolated values at time, in seconds on the model clock.

void	read_in_at_time (amrex::FArrayBox *vec, int itime)

Public Attributes
amrex::FArrayBox *	fab_interp
	Container for interpolated data; Only used if save_interpolated == true.

int	has_z
	Whether the field is specified in the z-dimension.

int	use_vert_integ

int	is_transport

amrex::FArrayBox *	fab_before
	FABs to pointers of river data.

amrex::FArrayBox *	fab_after

amrex::FArrayBox *	fab_vshape = nullptr
	Vshape data if needed.

Private Attributes
amrex::Vector< std::string >	file_names
	File names to read from.

std::string	field_name
	Field name in netcdf file.

std::string	time_name
	Field name for time series in netcdf file.

int	nriv
	Number of rivers.

int	nz
	Number of vertical points.

int	nzbox
	How many vertical cells there are in the data fabs.

double	time_ref

amrex::Vector< double >	river_times
	Time points in netcdf file, in seconds on the model clock.

amrex::Vector< int >	file_for_time
	File index to access a particular time.

amrex::Vector< int >	file_itime_offset
	Offset to access a particular time within its file.

int	i_time_before
	Time index immediately before the last time interpolated to.

double	time_before
	Time in ocean_time immediately before the last time interpolated to.

double	time_after
	Time in ocean_time immediately after the last time interpolated to.

Detailed Description

Definition at line 12 of file REMORA_NCTimeSeriesRiver.H.

Constructor & Destructor Documentation

◆ NCTimeSeriesRiver()

NCTimeSeriesRiver::NCTimeSeriesRiver	(	const amrex::Vector< std::string > &	a_file_names,
		const std::string	a_field_name,
		const std::string	a_time_name,
		const int	a_nz,
		double	a_time_ref,
		const int	a_use_vert_integ = `0`,
		const int	a_is_transport = `0`
	)

Parameters

[in]	a_file_names	vector of file name(s) to read from
[in]	a_field_name	name of field to read in
[in]	a_time_name	name of time variable in NetCDF file
[in]	a_nz	number of vertical levels in domain
[in]	a_time_ref	remora.time_ref, the reference date of the model clock
[in]	a_use_vert_integ	whether the data in the file is vertically integrated
[in]	a_is_transport	whether the field is the river transport rather than a tracer

Definition at line 19 of file REMORA_NCTimeSeriesRiver.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ Initialize()

void NCTimeSeriesRiver::Initialize ( )

Definition at line 33 of file REMORA_NCTimeSeriesRiver.cpp.

Here is the call graph for this function:

◆ read_in_at_time()

void NCTimeSeriesRiver::read_in_at_time	(	amrex::FArrayBox *	vec,
		int	itime
	)

Read in data from file at time index itime and fill into FAB

Definition at line 193 of file REMORA_NCTimeSeriesRiver.cpp.

Referenced by update_interpolated_to_time().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update_interpolated_to_time()

void NCTimeSeriesRiver::update_interpolated_to_time ( double time )

Calculate interpolated values at time, in seconds on the model clock.

Definition at line 143 of file REMORA_NCTimeSeriesRiver.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ fab_after

amrex::FArrayBox* NCTimeSeriesRiver::fab_after

Definition at line 42 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and update_interpolated_to_time().

◆ fab_before

amrex::FArrayBox* NCTimeSeriesRiver::fab_before

FABs to pointers of river data.

Definition at line 41 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and update_interpolated_to_time().

◆ fab_interp

amrex::FArrayBox* NCTimeSeriesRiver::fab_interp

Container for interpolated data; Only used if save_interpolated == true.

Definition at line 28 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and update_interpolated_to_time().

◆ fab_vshape

amrex::FArrayBox* NCTimeSeriesRiver::fab_vshape = nullptr

Vshape data if needed.

Definition at line 44 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and read_in_at_time().

◆ field_name

std::string NCTimeSeriesRiver::field_name

private

Field name in netcdf file.

Definition at line 55 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), NCTimeSeriesRiver(), read_in_at_time(), and update_interpolated_to_time().

◆ file_for_time

amrex::Vector<int> NCTimeSeriesRiver::file_for_time

private

File index to access a particular time.

Definition at line 74 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and read_in_at_time().

◆ file_itime_offset

amrex::Vector<int> NCTimeSeriesRiver::file_itime_offset

private

Offset to access a particular time within its file.

Definition at line 76 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and read_in_at_time().

◆ file_names

amrex::Vector<std::string> NCTimeSeriesRiver::file_names

private

File names to read from.

Definition at line 53 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), NCTimeSeriesRiver(), and read_in_at_time().

◆ has_z

int NCTimeSeriesRiver::has_z

Whether the field is specified in the z-dimension.

Definition at line 31 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and read_in_at_time().

◆ i_time_before

int NCTimeSeriesRiver::i_time_before

private

Time index immediately before the last time interpolated to.

Definition at line 78 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and update_interpolated_to_time().

◆ is_transport

int NCTimeSeriesRiver::is_transport

Whether this field is the river transport, as opposed to a tracer concentration. Only the transport is distributed in the vertical by river_Vshape (ROMS Qsrc = Qbar*Qshape)

Definition at line 38 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), NCTimeSeriesRiver(), and read_in_at_time().

◆ nriv

int NCTimeSeriesRiver::nriv

private

Number of rivers.

Definition at line 60 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), read_in_at_time(), and update_interpolated_to_time().

◆ nz

int NCTimeSeriesRiver::nz

private

Number of vertical points.

Definition at line 62 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), NCTimeSeriesRiver(), and read_in_at_time().

◆ nzbox

int NCTimeSeriesRiver::nzbox

private

How many vertical cells there are in the data fabs.

Definition at line 64 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), read_in_at_time(), and update_interpolated_to_time().

◆ river_times

amrex::Vector<double> NCTimeSeriesRiver::river_times

private

Time points in netcdf file, in seconds on the model clock.

Definition at line 72 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and update_interpolated_to_time().

◆ time_after

double NCTimeSeriesRiver::time_after

private

Time in ocean_time immediately after the last time interpolated to.

Definition at line 82 of file REMORA_NCTimeSeriesRiver.H.

Referenced by update_interpolated_to_time().

◆ time_before

double NCTimeSeriesRiver::time_before

private

Time in ocean_time immediately before the last time interpolated to.

Definition at line 80 of file REMORA_NCTimeSeriesRiver.H.

Referenced by update_interpolated_to_time().

◆ time_name

std::string NCTimeSeriesRiver::time_name

private

Field name for time series in netcdf file.

Definition at line 57 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and NCTimeSeriesRiver().

◆ time_ref

double NCTimeSeriesRiver::time_ref

private

remora.time_ref: the reference date the model clock counts from. The file's times are placed on that clock from the reference date in their units attribute. Double, like every reference date.

Definition at line 69 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and NCTimeSeriesRiver().

◆ use_vert_integ

int NCTimeSeriesRiver::use_vert_integ

Whether to use the depth-integrated value read from file; Used when !has_z

Definition at line 34 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), NCTimeSeriesRiver(), and read_in_at_time().

The documentation for this class was generated from the following files:

/home/runner/work/REMORA/REMORA/Source/IO/REMORA_NCTimeSeriesRiver.H
/home/runner/work/REMORA/REMORA/Source/IO/REMORA_NCTimeSeriesRiver.cpp

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NCTimeSeriesRiver()

Member Function Documentation

◆ Initialize()

◆ read_in_at_time()

◆ update_interpolated_to_time()

Member Data Documentation

◆ fab_after

◆ fab_before

◆ fab_interp

◆ fab_vshape

◆ field_name

◆ file_for_time

◆ file_itime_offset

◆ file_names

◆ has_z

◆ i_time_before

◆ is_transport

◆ nriv

◆ nz

◆ nzbox

◆ river_times

◆ time_after

◆ time_before

◆ time_name

◆ time_ref

◆ use_vert_integ