TECA
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
teca_tc_wind_radii Class Reference

computes wind radius at the specified coordinates More...

#include <teca_tc_wind_radii.h>

Inheritance diagram for teca_tc_wind_radii:
teca_algorithm

Classes

class  internals_t
 

Public Types

enum  { PROFILE_MAX = 0, PROFILE_AVERAGE = 1 }
 

Public Member Functions

std::shared_ptr< teca_tc_wind_radiishared_from_this ()
 
std::shared_ptr< teca_tc_wind_radii const > shared_from_this () const
 
 teca_tc_wind_radii (const teca_tc_wind_radii &src)=delete
 
 teca_tc_wind_radii (teca_tc_wind_radii &&src)=delete
 
teca_tc_wind_radiioperator= (const teca_tc_wind_radii &src)=delete
 
teca_tc_wind_radiioperator= (teca_tc_wind_radii &&src)=delete
 
const char * get_class_name () const override
 
void set_storm_id_column (const std::string &v)
 
const std::string & get_storm_id_column () const
 
void set_storm_x_coordinate_column (const std::string &v)
 
const std::string & get_storm_x_coordinate_column () const
 
void set_storm_y_coordinate_column (const std::string &v)
 
const std::string & get_storm_y_coordinate_column () const
 
void set_storm_wind_speed_column (const std::string &v)
 
const std::string & get_storm_wind_speed_column () const
 
void set_storm_time_column (const std::string &v)
 
const std::string & get_storm_time_column () const
 
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_search_radius (const double &v)
 
const double & get_search_radius () const
 
void set_core_radius (const double &v)
 
const double & get_core_radius () const
 
void set_number_of_radial_bins (const int &v)
 
const int & get_number_of_radial_bins () const
 
size_t get_number_of_critical_wind_speeds ()
 
void append_critical_wind_speed (const double &v)
 
void set_critical_wind_speed (size_t i, const double &v)
 
void set_critical_wind_speeds (const std::vector< double > &v)
 
void set_critical_wind_speeds (const std::initializer_list< double > &&l)
 
void set_critical_wind_speeds (const const_p_teca_variant_array &v)
 
const double & get_critical_wind_speed (size_t i) const
 
void get_critical_wind_speeds (std::vector< double > &v) const
 
void get_critical_wind_speeds (const p_teca_variant_array &v) const
 
void clear_critical_wind_speeds ()
 
void set_profile_type (const int &v)
 
const int & get_profile_type () const
 
void set_input_connection (unsigned int id, const teca_algorithm_output_port &port) override
 
- 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 ()
 
virtual teca_algorithm_output_port get_output_port (unsigned int port=0)
 
void set_input_connection (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_tc_wind_radii 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)
 
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

computes wind radius at the specified coordinates

Compute storm size and adds it to the table. There are two inputs, the first serves up tables of storms to compute the storm radius for. One must set the names of the columns that contain storm ids, x-coordnates, y-coordinates, and time coordinate. For each event the wind radius is computed. Computations are parallelized over storm id. The second input serves up wind velocity data most likely this will be from a NetCDF CF2 simulation dataset. By default radius is computed at the transitions on the Saffir-Simpson scale.


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