REMORA
Regional Modeling of Oceans Refined Adaptively
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Attributes | List of all members
NCTimeSeriesRiver Class Reference

#include <REMORA_NCTimeSeriesRiver.H>

Collaboration diagram for NCTimeSeriesRiver:
Collaboration graph
[legend]

Public Member Functions

 NCTimeSeriesRiver (const std::string a_file_name, const std::string a_field_name, const std::string a_time_name, const int a_nz, const int a_use_vert_integ=0)
 
void Initialize ()
 
void update_interpolated_to_time (amrex::Real time)
 Calculate.
 
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
 
amrex::FArrayBox * fab_before
 FABs to pointers of river data.
 
amrex::FArrayBox * fab_after
 
amrex::FArrayBox * fab_vshape
 Vshape data if needed.
 

Private Attributes

std::string file_name
 File name 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.
 
amrex::Vector< amrex::Real > river_times
 Time points in netcdf file.
 
int i_time_before
 Time index immediately before the last time interpolated to.
 
amrex::Real time_before
 Time in ocean_time immediately before the last time interpolated to.
 
amrex::Real 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 std::string  a_file_name,
const std::string  a_field_name,
const std::string  a_time_name,
const int  a_nz,
const int  a_use_vert_integ = 0 
)

Definition at line 9 of file REMORA_NCTimeSeriesRiver.cpp.

Member Function Documentation

◆ Initialize()

void NCTimeSeriesRiver::Initialize ( )

Definition at line 19 of file REMORA_NCTimeSeriesRiver.cpp.

Referenced by REMORA::init_only().

Here is the call graph for this function:
Here is the caller 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 145 of file REMORA_NCTimeSeriesRiver.cpp.

Referenced by update_interpolated_to_time().

Here is the caller graph for this function:

◆ update_interpolated_to_time()

void NCTimeSeriesRiver::update_interpolated_to_time ( amrex::Real  time)

Calculate.

Definition at line 109 of file REMORA_NCTimeSeriesRiver.cpp.

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

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

Member Data Documentation

◆ fab_after

amrex::FArrayBox* NCTimeSeriesRiver::fab_after

Definition at line 36 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 35 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 26 of file REMORA_NCTimeSeriesRiver.H.

Referenced by REMORA::advance_2d(), REMORA::advance_3d(), Initialize(), and update_interpolated_to_time().

◆ fab_vshape

amrex::FArrayBox* NCTimeSeriesRiver::fab_vshape

Vshape data if needed.

Definition at line 38 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 49 of file REMORA_NCTimeSeriesRiver.H.

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

◆ file_name

std::string NCTimeSeriesRiver::file_name
private

File name to read from.

Definition at line 47 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 29 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 63 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and update_interpolated_to_time().

◆ nriv

int NCTimeSeriesRiver::nriv
private

Number of rivers.

Definition at line 54 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 56 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 58 of file REMORA_NCTimeSeriesRiver.H.

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

◆ river_times

amrex::Vector<amrex::Real> NCTimeSeriesRiver::river_times
private

Time points in netcdf file.

Definition at line 61 of file REMORA_NCTimeSeriesRiver.H.

Referenced by Initialize(), and update_interpolated_to_time().

◆ time_after

amrex::Real NCTimeSeriesRiver::time_after
private

Time in ocean_time immediately after the last time interpolated to.

Definition at line 67 of file REMORA_NCTimeSeriesRiver.H.

Referenced by update_interpolated_to_time().

◆ time_before

amrex::Real NCTimeSeriesRiver::time_before
private

Time in ocean_time immediately before the last time interpolated to.

Definition at line 65 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 51 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 32 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: