Inverted Gaussian damper for scalar fields. More...

#include <teca_latitude_damper.h>

Inheritance diagram for teca_latitude_damper:

Collaboration diagram for teca_latitude_damper:

Public Member Functions
std::shared_ptr< teca_latitude_damper >	shared_from_this ()

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

	teca_latitude_damper (const teca_latitude_damper &src)=delete

	teca_latitude_damper (teca_latitude_damper &&src)=delete

teca_latitude_damper &	operator= (const teca_latitude_damper &src)=delete

teca_latitude_damper &	operator= (teca_latitude_damper &&src)=delete

const char *	get_class_name () const override

void	set_center (const double &v)

const double &	get_center () const

void	set_half_width_at_half_max (const double &v)

const double &	get_half_width_at_half_max () const

size_t	get_number_of_damped_variables ()

void	append_damped_variable (const std::string &v)

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

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

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

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

const std::vector< std::string > &	get_damped_variables () const

void	clear_damped_variables ()

void	set_variable_post_fix (const std::string &v)

const std::string &	get_variable_post_fix () 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_latitude_damper	New ()

Protected Member Functions
int	get_sigma (const teca_metadata &request, double &sigma)

int	get_mu (const teca_metadata &request, double &mu)

int	get_damped_variables (std::vector< std::string > &vars)

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

Inverted Gaussian damper for scalar fields.

Damps the specified scalar field(s) using an inverted Gaussian centered on a given latitude with a half width specified in degrees latitude. The parameters defining the Gaussian (center, half width at half max) can be specified by the user directly or by down stream algorithm via the following keys in the request.

request keys:

teca_latitude_damper::damped_variables teca_latitude_damper::half_width_at_half_max teca_latitude_damper::center

Note: User specified values take precedence over request keys. When using request keys be sure to include the variable post-fix.

Member Function Documentation

◆ append_damped_variable()

void teca_latitude_damper::append_damped_variable ( const std::string & v )

inline

append to the damped_variable algorithm vector property

◆ clear_damped_variables()

void teca_latitude_damper::clear_damped_variables ( )

inline

clear the damped_variable algorithm vector property

◆ get_center()

const double& teca_latitude_damper::get_center ( ) const

inline

Get the value of the center algorithm property

◆ get_class_name()

const char* teca_latitude_damper::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_damped_variable()

const std::string& teca_latitude_damper::get_damped_variable ( size_t i ) const

inline

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

◆ get_damped_variables()

const std::vector< std::string >& teca_latitude_damper::get_damped_variables ( ) const

inline

get the damped_variable algorithm vector property

◆ get_half_width_at_half_max()

const double& teca_latitude_damper::get_half_width_at_half_max ( ) const

inline

Get the value of the half_width_at_half_max algorithm property

◆ get_number_of_damped_variables()

size_t teca_latitude_damper::get_number_of_damped_variables ( )

inline

get the size of the damped_variable algorithm vector property

◆ get_variable_post_fix()

const std::string& teca_latitude_damper::get_variable_post_fix ( ) const

inline

Get the value of the variable_post_fix algorithm property

◆ New()

static p_teca_latitude_damper teca_latitude_damper::New ( )

inlinestatic

Returns an instance of teca_latitude_damper

◆ set_center()

void teca_latitude_damper::set_center ( const double & v )

inline

Set the value of the center algorithm property

◆ set_damped_variable()

void teca_latitude_damper::set_damped_variable	(	size_t	i,
		const std::string &	v
	)

inline

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

◆ set_damped_variables() [1/2]

void teca_latitude_damper::set_damped_variables ( const std::initializer_list< std::string > && l )

inline

set the damped_variable algorithm vector property

◆ set_damped_variables() [2/2]

void teca_latitude_damper::set_damped_variables ( const std::vector< std::string > & v )

inline

set the damped_variable algorithm vector property

◆ set_half_width_at_half_max()

void teca_latitude_damper::set_half_width_at_half_max ( const double & v )

inline

Set the value of the half_width_at_half_max algorithm property

◆ set_variable_post_fix()

void teca_latitude_damper::set_variable_post_fix ( const std::string & v )

inline

Set the value of the variable_post_fix algorithm property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

rtd_doxygen/alg/teca_latitude_damper.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ append_damped_variable()

◆ clear_damped_variables()

◆ get_center()

◆ get_class_name()

◆ get_damped_variable()

◆ get_damped_variables()

◆ get_half_width_at_half_max()

◆ get_number_of_damped_variables()

◆ get_variable_post_fix()

◆ New()

◆ set_center()

◆ set_damped_variable()

◆ set_damped_variables() [1/2]

◆ set_damped_variables() [2/2]

◆ set_half_width_at_half_max()

◆ set_variable_post_fix()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]