Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
List of all members
teca_l2_norm Class Reference
An algorithm that computes L2 norm. More...
#include <teca_l2_norm.h>
Inheritance diagram for teca_l2_norm:
Collaboration diagram for teca_l2_norm:
Public Member Functions | |
| std::shared_ptr< teca_l2_norm > | shared_from_this () |
| std::shared_ptr< teca_l2_norm const > | shared_from_this () const |
| teca_l2_norm (const teca_l2_norm &src)=delete | |
| teca_l2_norm (teca_l2_norm &&src)=delete | |
| teca_l2_norm & | operator= (const teca_l2_norm &src)=delete |
| teca_l2_norm & | operator= (teca_l2_norm &&src)=delete |
| const char * | get_class_name () const override |
component_0_variable | |
Set the arrays that contain the vector components to compute the norm from. | |
| void | set_component_0_variable (const std::string &v) |
| const std::string & | get_component_0_variable () const |
component_1_variable | |
Set the arrays that contain the vector components to compute the norm from. | |
| void | set_component_1_variable (const std::string &v) |
| const std::string & | get_component_1_variable () const |
component_2_variable | |
Set the arrays that contain the vector components to compute the norm from. | |
| void | set_component_2_variable (const std::string &v) |
| const std::string & | get_component_2_variable () const |
l2_norm_variable | |
set the name of the array to store the result in. the default is "l2_norm" | |
| void | set_l2_norm_variable (const std::string &v) |
| const std::string & | get_l2_norm_variable () const |
 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_l2_norm | New () |
Protected Member Functions | |
| std::string | get_component_0_variable (const teca_metadata &request) |
| std::string | get_component_1_variable (const teca_metadata &request) |
| std::string | get_component_2_variable (const teca_metadata &request) |
| std::string | get_l2_norm_variable (const teca_metadata &request) |
| 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 ¤t) |
| virtual const_p_teca_dataset | request_data (teca_algorithm_output_port &port, const teca_metadata &request) |
| virtual int | validate_cache (teca_algorithm_output_port ¤t) |
| 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
An algorithm that computes L2 norm.
Member Function Documentation
◆ get_class_name()
|
inlineoverridevirtual |
returns the name of the class
Implements teca_algorithm.
◆ get_component_0_variable()
|
inline |
Get the value of the component_0_variable algorithm property
◆ get_component_1_variable()
|
inline |
Get the value of the component_1_variable algorithm property
◆ get_component_2_variable()
|
inline |
Get the value of the component_2_variable algorithm property
◆ get_l2_norm_variable()
|
inline |
Get the value of the l2_norm_variable algorithm property
◆ New()
|
inlinestatic |
Returns an instance of teca_l2_norm
◆ set_component_0_variable()
|
inline |
Set the value of the component_0_variable algorithm property
◆ set_component_1_variable()
|
inline |
Set the value of the component_1_variable algorithm property
◆ set_component_2_variable()
|
inline |
Set the value of the component_2_variable algorithm property
◆ set_l2_norm_variable()
|
inline |
Set the value of the l2_norm_variable algorithm property
◆ shared_from_this() [1/2]
|
inline |
Enables the static constructor
◆ shared_from_this() [2/2]
|
inline |
Enables the static constructor
The documentation for this class was generated from the following file:
- rtd_doxygen/alg/teca_l2_norm.h
