TECA
The Toolkit for Extreme Climate Analysis
teca_vertical_coordinate_transform Class Reference

An algorithm that transforms the vertical cooridinates of a mesh. More...

#include <teca_vertical_coordinate_transform.h>

Inheritance diagram for teca_vertical_coordinate_transform:
[legend]
Collaboration diagram for teca_vertical_coordinate_transform:
[legend]

Public Types

enum  { mode_invalid = 0 , mode_wrf_v3 = 1 }
 

Public Member Functions

std::shared_ptr< teca_vertical_coordinate_transformshared_from_this ()
 
std::shared_ptr< teca_vertical_coordinate_transform const > shared_from_this () const
 
 teca_vertical_coordinate_transform (const teca_vertical_coordinate_transform &src)=delete
 
 teca_vertical_coordinate_transform (teca_vertical_coordinate_transform &&src)=delete
 
teca_vertical_coordinate_transformoperator= (const teca_vertical_coordinate_transform &src)=delete
 
teca_vertical_coordinate_transformoperator= (teca_vertical_coordinate_transform &&src)=delete
 
const char * get_class_name () const override
 
void set_mode (const int &v)
 
const int & get_mode () const
 
- Public Member Functions inherited from teca_algorithm
 teca_algorithm (const teca_algorithm &src)=delete
 
 teca_algorithm (teca_algorithm &&src)=delete
 
teca_algorithmoperator= (const teca_algorithm &src)=delete
 
teca_algorithmoperator= (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_coordinate_transform New ()
 

Additional Inherited Members

- 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_portget_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 transforms the vertical cooridinates of a mesh.

Member Function Documentation

◆ get_class_name()

const char* teca_vertical_coordinate_transform::get_class_name ( ) const
inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_mode()

const int& teca_vertical_coordinate_transform::get_mode ( ) const
inline

Get the value of the mode algorithm property

◆ New()

static p_teca_vertical_coordinate_transform teca_vertical_coordinate_transform::New ( )
inlinestatic

Returns an instance of teca_vertical_coordinate_transform

◆ set_mode()

void teca_vertical_coordinate_transform::set_mode ( const int &  v)
inline

Set the value of the mode algorithm property

◆ shared_from_this() [1/2]

std::shared_ptr< teca_vertical_coordinate_transform > teca_vertical_coordinate_transform::shared_from_this ( )
inline

Enables the static constructor

◆ shared_from_this() [2/2]

std::shared_ptr< teca_vertical_coordinate_transform const> teca_vertical_coordinate_transform::shared_from_this ( ) const
inline

Enables the static constructor


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