Transfers data between spatially overlapping meshes of potentially different resolutions. More...

#include <teca_cartesian_mesh_regrid.h>

Inheritance diagram for teca_cartesian_mesh_regrid:

Collaboration diagram for teca_cartesian_mesh_regrid:

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

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

	teca_cartesian_mesh_regrid (const teca_cartesian_mesh_regrid &src)=delete

	teca_cartesian_mesh_regrid (teca_cartesian_mesh_regrid &&src)=delete

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

teca_cartesian_mesh_regrid &	operator= (teca_cartesian_mesh_regrid &&src)=delete

const char *	get_class_name () const override

array
set the list of arrays to move from the source to the target
size_t	get_number_of_arrays ()

void	append_array (const std::string &v)

void	set_array (const std::string &v)

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

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

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

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

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

void	clear_arrays ()

target_input
set the input connection which provides the output geometry.
void	set_target_input (const int &v)

const int &	get_target_input () 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_cartesian_mesh_regrid	New ()

interpolation_mode
set the interpolation mode used in transfering data between meshes of differing resolution. in nearest mode value at the nearest grid point is used, in linear mode bi/tri linear interpolation is used.
enum	{ nearest =0 , linear =1 }

void	set_interpolation_mode (const int &v)

const int &	get_interpolation_mode () const

void	set_interpolation_mode_nearest ()

void	set_interpolation_mode_linear ()

	teca_cartesian_mesh_regrid ()

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_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...

Protected Attributes inherited from teca_algorithm
int	verbose

Detailed Description

Transfers data between spatially overlapping meshes of potentially different resolutions.

an algorithm that transfers data between cartesian meshes defined in the same world coordinate system but potentially different resolutions. nearest or linear interpolation are supported.

By default the first input is the target mesh. the second input is the source mesh. This can be changed by setting the target_input property.

the arrays to move from source to target can be selected using add_array api or in the request key "arrays". this is a spatial regriding operation for temporal regriding see teca_mesh_temporal_regrid.

Member Function Documentation

◆ append_array()

void teca_cartesian_mesh_regrid::append_array ( const std::string & v )

inline

append to the array algorithm vector property

◆ clear_arrays()

void teca_cartesian_mesh_regrid::clear_arrays ( )

inline

clear the array algorithm vector property

◆ get_array()

const std::string& teca_cartesian_mesh_regrid::get_array ( size_t i ) const

inline

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

◆ get_arrays()

const std::vector< std::string >& teca_cartesian_mesh_regrid::get_arrays ( ) const

inline

get the array algorithm vector property

◆ get_class_name()

const char* teca_cartesian_mesh_regrid::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_interpolation_mode()

const int& teca_cartesian_mesh_regrid::get_interpolation_mode ( ) const

inline

Get the value of the interpolation_mode algorithm property

◆ get_number_of_arrays()

size_t teca_cartesian_mesh_regrid::get_number_of_arrays ( )

inline

get the size of the array algorithm vector property

◆ get_target_input()

const int& teca_cartesian_mesh_regrid::get_target_input ( ) const

inline

Get the value of the target_input algorithm property

◆ New()

static p_teca_cartesian_mesh_regrid teca_cartesian_mesh_regrid::New ( )

inlinestatic

Returns an instance of teca_cartesian_mesh_regrid

◆ set_array() [1/2]

void teca_cartesian_mesh_regrid::set_array ( const std::string & v )

inline

set the array algorithm vector property to a single value

◆ set_array() [2/2]

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

inline

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

◆ set_arrays() [1/2]

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

inline

set the array algorithm vector property

◆ set_arrays() [2/2]

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

inline

set the array algorithm vector property

◆ set_interpolation_mode()

void teca_cartesian_mesh_regrid::set_interpolation_mode ( const int & v )

inline

Set the value of the interpolation_mode algorithm property

◆ set_target_input()

void teca_cartesian_mesh_regrid::set_target_input ( const int & v )

inline

Set the value of the target_input algorithm property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

rtdfixjuly2025/alg/teca_cartesian_mesh_regrid.h

Public Member Functions

Static Public Member Functions

interpolation_mode

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ append_array()

◆ clear_arrays()

◆ get_array()

◆ get_arrays()

◆ get_class_name()

◆ get_interpolation_mode()

◆ get_number_of_arrays()

◆ get_target_input()

◆ New()

◆ set_array() [1/2]

◆ set_array() [2/2]

◆ set_arrays() [1/2]

◆ set_arrays() [2/2]

◆ set_interpolation_mode()

◆ set_target_input()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]