an algorithm that computes integrated vapor transport (IVT) More...

#include <teca_integrated_vapor_transport.h>

Inheritance diagram for teca_integrated_vapor_transport:

Public Member Functions
std::shared_ptr< teca_integrated_vapor_transport >	shared_from_this ()

std::shared_ptr< teca_integrated_vapor_transport const >	shared_from_this () const

	teca_integrated_vapor_transport (const teca_integrated_vapor_transport &src)=delete

	teca_integrated_vapor_transport (teca_integrated_vapor_transport &&src)=delete

teca_integrated_vapor_transport &	operator= (const teca_integrated_vapor_transport &src)=delete

teca_integrated_vapor_transport &	operator= (teca_integrated_vapor_transport &&src)=delete

const char *	get_class_name () const override

void	set_wind_u_variable (const std::string &v)

const std::string &	get_wind_u_variable () const

void	set_wind_v_variable (const std::string &v)

const std::string &	get_wind_v_variable () const

void	set_specific_humidity_variable (const std::string &v)

const std::string &	get_specific_humidity_variable () const

void	set_ivt_u_variable (const std::string &v)

const std::string &	get_ivt_u_variable () const

void	set_ivt_v_variable (const std::string &v)

const std::string &	get_ivt_v_variable () const

void	set_fill_value (const double &v)

const double &	get_fill_value () const

Public Member Functions inherited from teca_vertical_reduction
std::shared_ptr< teca_vertical_reduction >	shared_from_this ()

std::shared_ptr< teca_vertical_reduction const >	shared_from_this () const

	teca_vertical_reduction (const teca_vertical_reduction &src)=delete

	teca_vertical_reduction (teca_vertical_reduction &&src)=delete

teca_vertical_reduction &	operator= (const teca_vertical_reduction &src)=delete

teca_vertical_reduction &	operator= (teca_vertical_reduction &&src)=delete

const char *	get_class_name () const override

size_t	get_number_of_dependent_variables ()

void	append_dependent_variable (const std::string &v)

void	set_dependent_variable (size_t i, const std::string &v)

void	set_dependent_variables (const std::vector< std::string > &v)

void	set_dependent_variables (const std::initializer_list< std::string > &&l)

void	set_dependent_variables (const const_p_teca_variant_array &v)

const std::string &	get_dependent_variable (size_t i) const

void	get_dependent_variables (std::vector< std::string > &v) const

void	get_dependent_variables (const p_teca_variant_array &v) const

void	clear_dependent_variables ()

size_t	get_number_of_derived_variables ()

void	append_derived_variable (const std::string &v)

void	set_derived_variable (size_t i, const std::string &v)

void	set_derived_variables (const std::vector< std::string > &v)

void	set_derived_variables (const std::initializer_list< std::string > &&l)

void	set_derived_variables (const const_p_teca_variant_array &v)

const std::string &	get_derived_variable (size_t i) const

void	get_derived_variables (std::vector< std::string > &v) const

void	get_derived_variables (const p_teca_variant_array &v) const

void	clear_derived_variables ()

size_t	get_number_of_derived_variable_attributes ()

void	append_derived_variable_attribute (const teca_array_attributes &v)

void	set_derived_variable_attribute (size_t i, const teca_array_attributes &v)

void	set_derived_variable_attributes (const std::vector< teca_array_attributes > &v)

void	set_derived_variable_attributes (const std::initializer_list< teca_array_attributes > &&l)

void	set_derived_variable_attributes (const const_p_teca_variant_array &v)

const teca_array_attributes &	get_derived_variable_attribute (size_t i) const

void	get_derived_variable_attributes (std::vector< teca_array_attributes > &v) const

void	get_derived_variable_attributes (const p_teca_variant_array &v) const

void	clear_derived_variable_attributes ()

Public Member Functions inherited from teca_algorithm
	teca_algorithm (const teca_algorithm &src)=delete

	teca_algorithm (teca_algorithm &&src)=delete

teca_algorithm &	operator= (const teca_algorithm &src)=delete

teca_algorithm &	operator= (teca_algorithm &&src)=delete

void	set_communicator (MPI_Comm comm)

MPI_Comm	get_communicator ()

virtual teca_algorithm_output_port	get_output_port (unsigned int port=0)

void	set_input_connection (const teca_algorithm_output_port &port)

virtual void	set_input_connection (unsigned int id, const teca_algorithm_output_port &port)

virtual void	remove_input_connection (unsigned int id)

void	clear_input_connections ()

const_p_teca_dataset	get_output_data (unsigned int port=0)

void	pop_cache (unsigned int port=0, int top=0)

void	set_cache_size (unsigned int n)

virtual int	update ()

virtual int	update (unsigned int port)

virtual teca_metadata	update_metadata (unsigned int port=0)

void	set_executive (p_teca_algorithm_executive exe)

p_teca_algorithm_executive	get_executive ()

virtual void	to_stream (std::ostream &s) const

virtual void	from_stream (std::istream &s)

Static Public Member Functions
static p_teca_integrated_vapor_transport	New ()

Static Public Member Functions inherited from teca_vertical_reduction
static p_teca_vertical_reduction	New ()

Additional Inherited Members
Protected Member Functions inherited from teca_vertical_reduction
teca_metadata	get_output_metadata (unsigned int port, const std::vector< teca_metadata > &input_md) override

std::vector< teca_metadata >	get_upstream_request (unsigned int port, const std::vector< teca_metadata > &input_md, const teca_metadata &request) override

const_p_teca_dataset	execute (unsigned int port, const std::vector< const_p_teca_dataset > &input_data, const teca_metadata &request) override

Protected Member Functions inherited from teca_algorithm
void	set_number_of_input_connections (unsigned int n)

void	set_number_of_output_ports (unsigned int n)

virtual void	set_modified ()

void	set_modified (unsigned int port)

virtual teca_metadata	get_cache_key (unsigned int port, const teca_metadata &request) const

virtual teca_metadata	get_output_metadata (teca_algorithm_output_port &current)

virtual const_p_teca_dataset	request_data (teca_algorithm_output_port &port, const teca_metadata &request)

virtual int	validate_cache (teca_algorithm_output_port &current)

virtual void	clear_modified (teca_algorithm_output_port current)

const_p_teca_dataset	get_output_data (unsigned int port, const teca_metadata &request)

int	cache_output_data (unsigned int port, const teca_metadata &request, const_p_teca_dataset &data)

void	clear_cache (unsigned int port)

unsigned int	get_number_of_input_connections ()

teca_algorithm_output_port &	get_input_connection (unsigned int i)

void	clear_modified (unsigned int port)

int	get_modified (unsigned int port) const

Detailed Description

an algorithm that computes integrated vapor transport (IVT)

Compute integrated vaport transport (IVT) from wind vector and specific humidity.

IVT = - \frac{1}{g} \int_{p_0}^{p_1} \vec{v} q dp

where q is the specific humidity, and \vec{v} = (u, v) are the longitudinal and latitudinal components of wind.

This calculation is an instance of a vertical reduction where a 3D mesh is transformed into a 2D one.

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

TECA/alg/teca_integrated_vapor_transport.h
TECA/alg/teca_integrated_vapor_transport.cxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description