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

#include <teca_integrated_vapor_transport.h>

Inheritance diagram for teca_integrated_vapor_transport:

Collaboration 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

wind_u_variable
set the name of the varaiable that contains the longitudinal component of the wind vector ("ua")
void	set_wind_u_variable (const std::string &v)

const std::string &	get_wind_u_variable () const

wind_v_variable
set the name of the varaiable that contains the latitudinal component of the wind vector ("va")
void	set_wind_v_variable (const std::string &v)

const std::string &	get_wind_v_variable () const

specific_humidity_variable
set the name of the variable that contains the specific humidity ("hus")
void	set_specific_humidity_variable (const std::string &v)

const std::string &	get_specific_humidity_variable () const

ivt_u_variable
set the name of the varaiable that contains the longitudinal component of the ivt vector ("ivt_u")
void	set_ivt_u_variable (const std::string &v)

const std::string &	get_ivt_u_variable () const

ivt_v_variable
set the name of the varaiable that contains the latitudinal component of the ivt vector ("ivt_v")
void	set_ivt_v_variable (const std::string &v)

const std::string &	get_ivt_v_variable () const

fill_value
set the _fillValue attribute for the output data. default 1.0e20
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)

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

const std::vector< std::string > &	get_dependent_variables () 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)

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

const std::vector< std::string > &	get_derived_variables () 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)

const teca_array_attributes &	get_derived_variable_attribute (size_t i) const

const std::vector< teca_array_attributes > &	get_derived_variable_attributes () 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 ()
	get the active communicator More...

virtual teca_algorithm_output_port	get_output_port (unsigned int port=0)

void	set_input_connection (const teca_algorithm_output_port &port)
	set an input to this algorithm More...

virtual void	set_input_connection (unsigned int id, const teca_algorithm_output_port &port)
	set an input to this algorithm More...

virtual void	remove_input_connection (unsigned int id)
	remove input connections More...

void	clear_input_connections ()
	remove all input connections More...

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)
	set the cache size. the default is 1. (threadsafe) More...

virtual int	update ()
	execute the pipeline from this instance up. More...

virtual int	update (unsigned int port)
	execute the pipeline from this instance up. More...

virtual teca_metadata	update_metadata (unsigned int port=0)
	get meta data considering this instance up. More...

void	set_executive (p_teca_algorithm_executive exe)
	set the executive More...

p_teca_algorithm_executive	get_executive ()
	get the executive More...

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

virtual void	from_stream (std::istream &s)
	deserialize from the stream. More...

void	set_verbose (const int &v)

const int &	get_verbose () const

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

virtual teca_metadata	get_output_metadata (unsigned int port, const std::vector< teca_metadata > &input_md)

virtual teca_metadata	get_output_metadata (teca_algorithm_output_port &current)

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)
	an overload to set_modified by port More...

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)
	clear the cache on the given output port More...

unsigned int	get_number_of_input_connections ()
	get the number of input connections More...

teca_algorithm_output_port &	get_input_connection (unsigned int i)

void	clear_modified (unsigned int port)
	clear the modified flag on the i'th output More...

int	get_modified (unsigned int port) const
	return the output port's modified flag value More...

Protected Attributes inherited from teca_algorithm
int	verbose

Detailed Description

An algorithm that computes integrated vapor transport (IVT)

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

\[ IVT = \frac{1}{g} \int_{p_{sfc}}^{p_{top}} \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.

Member Function Documentation

◆ get_class_name()

const char* teca_integrated_vapor_transport::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_fill_value()

const double& teca_integrated_vapor_transport::get_fill_value ( ) const

inline

Get the value of the fill_value algorithm property

◆ get_ivt_u_variable()

const std::string& teca_integrated_vapor_transport::get_ivt_u_variable ( ) const

inline

Get the value of the ivt_u_variable algorithm property

◆ get_ivt_v_variable()

const std::string& teca_integrated_vapor_transport::get_ivt_v_variable ( ) const

inline

Get the value of the ivt_v_variable algorithm property

◆ get_specific_humidity_variable()

const std::string& teca_integrated_vapor_transport::get_specific_humidity_variable ( ) const

inline

Get the value of the specific_humidity_variable algorithm property

◆ get_wind_u_variable()

const std::string& teca_integrated_vapor_transport::get_wind_u_variable ( ) const

inline

Get the value of the wind_u_variable algorithm property

◆ get_wind_v_variable()

const std::string& teca_integrated_vapor_transport::get_wind_v_variable ( ) const

inline

Get the value of the wind_v_variable algorithm property

◆ New()

static p_teca_integrated_vapor_transport teca_integrated_vapor_transport::New ( )

inlinestatic

Returns an instance of teca_integrated_vapor_transport

◆ set_fill_value()

void teca_integrated_vapor_transport::set_fill_value ( const double & v )

inline

Set the value of the fill_value algorithm property

◆ set_ivt_u_variable()

void teca_integrated_vapor_transport::set_ivt_u_variable ( const std::string & v )

inline

Set the value of the ivt_u_variable algorithm property

◆ set_ivt_v_variable()

void teca_integrated_vapor_transport::set_ivt_v_variable ( const std::string & v )

inline

Set the value of the ivt_v_variable algorithm property

◆ set_specific_humidity_variable()

void teca_integrated_vapor_transport::set_specific_humidity_variable ( const std::string & v )

inline

Set the value of the specific_humidity_variable algorithm property

◆ set_wind_u_variable()

void teca_integrated_vapor_transport::set_wind_u_variable ( const std::string & v )

inline

Set the value of the wind_u_variable algorithm property

◆ set_wind_v_variable()

void teca_integrated_vapor_transport::set_wind_v_variable ( const std::string & v )

inline

Set the value of the wind_v_variable algorithm property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

stable/alg/teca_integrated_vapor_transport.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_class_name()

◆ get_fill_value()

◆ get_ivt_u_variable()

◆ get_ivt_v_variable()

◆ get_specific_humidity_variable()

◆ get_wind_u_variable()

◆ get_wind_v_variable()

◆ New()

◆ set_fill_value()

◆ set_ivt_u_variable()

◆ set_ivt_v_variable()

◆ set_specific_humidity_variable()

◆ set_wind_u_variable()

◆ set_wind_v_variable()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]