teca_vertical_reduction Class Reference

The base class for vertical reducitons. More...

#include <teca_vertical_reduction.h>

Inheritance diagram for teca_vertical_reduction:

Collaboration diagram for teca_vertical_reduction:

Public Member Functions
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
dependent_variable
set/get the list of variables that are needed to produce the derived quantity
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 ()
derived_variable
set/get the name of the variable that is produced
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 ()
derived_variable_attribute
Set the attributes of the variable that is produced.
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_vertical_reduction	New ()

Protected Member Functions
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)
	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...

Additional Inherited Members
Protected Attributes inherited from teca_algorithm
int	verbose

Detailed Description

The base class for vertical reducitons.

implements common operations associated with computing a vertical reduction where a 3D dataset is transformed into a 2D dataset by a reduction along the 3rd spatial dimension.

Member Function Documentation

append_dependent_variable()

void teca_vertical_reduction::append_dependent_variable ( const std::string &  v )

inline

append to the dependent_variable algorithm vector property

append_derived_variable()

void teca_vertical_reduction::append_derived_variable ( const std::string &  v )

inline

append to the derived_variable algorithm vector property

append_derived_variable_attribute()

void teca_vertical_reduction::append_derived_variable_attribute ( const teca_array_attributes &  v )

inline

append to the derived_variable_attribute algorithm vector property

clear_dependent_variables()

void teca_vertical_reduction::clear_dependent_variables ( )

inline

clear the dependent_variable algorithm vector property

clear_derived_variable_attributes()

void teca_vertical_reduction::clear_derived_variable_attributes ( )

inline

clear the derived_variable_attribute algorithm vector property

clear_derived_variables()

void teca_vertical_reduction::clear_derived_variables ( )

inline

clear the derived_variable algorithm vector property

execute()

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

overrideprotectedvirtual

implementations must override this method and produce the output dataset for the port named in the first argument. The second argument is a list of all of the input datasets. See also get_request. The third argument contains a request from the consumer which can specify information such as arrays, subset region, timestep etc. The implementation is free to handle the request as it sees fit.

Reimplemented from teca_algorithm.

get_class_name()

const char* teca_vertical_reduction::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

get_dependent_variable()

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

inline

get the i-th element of the dependent_variable algorithm vector property

get_dependent_variables()

const std::vector< std::string >& teca_vertical_reduction::get_dependent_variables ( ) const

inline

get the dependent_variable algorithm vector property

get_derived_variable()

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

inline

get the i-th element of the derived_variable algorithm vector property

get_derived_variable_attribute()

const teca_array_attributes& teca_vertical_reduction::get_derived_variable_attribute ( size_t  i ) const

inline

get the i-th element of the derived_variable_attribute algorithm vector property

get_derived_variable_attributes()

const std::vector< teca_array_attributes >& teca_vertical_reduction::get_derived_variable_attributes ( ) const

inline

get the derived_variable_attribute algorithm vector property

get_derived_variables()

const std::vector< std::string >& teca_vertical_reduction::get_derived_variables ( ) const

inline

get the derived_variable algorithm vector property

get_number_of_dependent_variables()

size_t teca_vertical_reduction::get_number_of_dependent_variables ( )

inline

get the size of the dependent_variable algorithm vector property

get_number_of_derived_variable_attributes()

size_t teca_vertical_reduction::get_number_of_derived_variable_attributes ( )

inline

get the size of the derived_variable_attribute algorithm vector property

get_number_of_derived_variables()

size_t teca_vertical_reduction::get_number_of_derived_variables ( )

inline

get the size of the derived_variable algorithm vector property

get_output_metadata()

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

overrideprotectedvirtual

implementations must override this method to provide information to downstream consumers about what data will be produced on each output port. The port to provide information about is named in the first argument the second argument contains a list of the metadata describing data on all of the inputs.

Reimplemented from teca_algorithm.

get_upstream_request()

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

overrideprotectedvirtual

implementations must override this method and generate a set of requests describing the data required on the inputs to produce data for the named output port, given the upstream meta data and request. If no data is needed on an input then the list should contain a null request.

Reimplemented from teca_algorithm.

New()

static p_teca_vertical_reduction teca_vertical_reduction::New ( )

inlinestatic

Returns an instance of teca_vertical_reduction

set_dependent_variable()

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

inline

set the i-th element of the dependent_variable algorithm vector property

set_dependent_variables() [1/2]

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

inline

set the dependent_variable algorithm vector property

set_dependent_variables() [2/2]

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

inline

set the dependent_variable algorithm vector property

set_derived_variable()

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

inline

set the i-th element of the derived_variable algorithm vector property

set_derived_variable_attribute()

void teca_vertical_reduction::set_derived_variable_attribute ( size_t  i, const teca_array_attributes &  v  )

inline

set the i-th element of the derived_variable_attribute algorithm vector property

set_derived_variable_attributes() [1/2]

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

inline

set the derived_variable_attribute algorithm vector property

set_derived_variable_attributes() [2/2]

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

inline

set the derived_variable_attribute algorithm vector property

set_derived_variables() [1/2]

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

inline

set the derived_variable algorithm vector property

set_derived_variables() [2/2]

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

inline

set the derived_variable algorithm vector property

shared_from_this() [1/2]

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

inline

Enables the static constructor

shared_from_this() [2/2]

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

inline

Enables the static constructor

---

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

• rtd_doxygen/alg/teca_vertical_reduction.h