Data on a uniform cartesian mesh. More...

#include <teca_uniform_cartesian_mesh.h>

Inheritance diagram for teca_uniform_cartesian_mesh:

Collaboration diagram for teca_uniform_cartesian_mesh:

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

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

virtual p_teca_dataset	new_instance () const override

virtual p_teca_dataset	new_copy (allocator alloc=allocator::malloc) const override

virtual p_teca_dataset	new_shallow_copy () override

void	set_time (const std::vector< double > &vals)

int	get_time (std::vector< double > &vals) const

void	set_time (const p_teca_variant_array &vals)

int	get_time (p_teca_variant_array vals) const

void	set_time (const std::initializer_list< double > &l)

void	set_time (const double *vals)

int	get_time (double *vals) const

void	set_time (const double &val_1)

int	get_time (double &val_1) const

void	set_time_step (const std::vector< unsigned long > &vals)

int	get_time_step (std::vector< unsigned long > &vals) const

void	set_time_step (const p_teca_variant_array &vals)

int	get_time_step (p_teca_variant_array vals) const

void	set_time_step (const std::initializer_list< unsigned long > &l)

void	set_time_step (const unsigned long *vals)

int	get_time_step (unsigned long *vals) const

void	set_time_step (const unsigned long &val_1)

int	get_time_step (unsigned long &val_1) const

void	set_spacing (const std::vector< double > &vals)

int	get_spacing (std::vector< double > &vals) const

void	set_spacing (const p_teca_variant_array &vals)

int	get_spacing (p_teca_variant_array vals) const

void	set_spacing (const std::initializer_list< double > &l)

void	set_spacing (const double *vals)

int	get_spacing (double *vals) const

void	set_spacing (const double &val_1, const double &val_2, const double &val_3)

int	get_spacing (double &val_1, double &val_2, double &val_3) const

void	set_origin (const std::vector< double > &vals)

int	get_origin (std::vector< double > &vals) const

void	set_origin (const p_teca_variant_array &vals)

int	get_origin (p_teca_variant_array vals) const

void	set_origin (const std::initializer_list< double > &l)

void	set_origin (const double *vals)

int	get_origin (double *vals) const

void	set_origin (const double &val_1, const double &val_2, const double &val_3)

int	get_origin (double &val_1, double &val_2, double &val_3) const

void	set_extent (const std::vector< unsigned long > &vals)

int	get_extent (std::vector< unsigned long > &vals) const

void	set_extent (const p_teca_variant_array &vals)

int	get_extent (p_teca_variant_array vals) const

void	set_extent (const std::initializer_list< unsigned long > &l)

void	set_extent (const unsigned long *vals)

int	get_extent (unsigned long *vals) const

void	set_extent (const unsigned long &val_1, const unsigned long &val_2, const unsigned long &val_3, const unsigned long &val_4, const unsigned long &val_5, const unsigned long &val_6)

void	set_whole_extent (const std::vector< unsigned long > &vals)

int	get_whole_extent (std::vector< unsigned long > &vals) const

void	set_whole_extent (const p_teca_variant_array &vals)

int	get_whole_extent (p_teca_variant_array vals) const

void	set_whole_extent (const std::initializer_list< unsigned long > &l)

void	set_whole_extent (const unsigned long *vals)

int	get_whole_extent (unsigned long *vals) const

void	set_whole_extent (const unsigned long &val_1, const unsigned long &val_2, const unsigned long &val_3, const unsigned long &val_4, const unsigned long &val_5, const unsigned long &val_6)

unsigned long	get_number_of_points () const override
	get the number of points in the mesh More...

unsigned long	get_number_of_cells () const override
	get the number of cells in the mesh More...

std::string	get_class_name () const override
	return a unique string identifier More...

int	get_type_code () const override
	return a unique integer identifier More...

void	copy (const const_p_teca_dataset &other, allocator alloc=allocator::malloc) override

void	shallow_copy (const p_teca_dataset &other) override

void	swap (const p_teca_dataset &) override
	swap internals of the two objects More...

Public Member Functions inherited from teca_mesh
void	set_time (const std::vector< double > &vals)

int	get_time (std::vector< double > &vals) const

void	set_time (const p_teca_variant_array &vals)

int	get_time (p_teca_variant_array vals) const

void	set_time (const std::initializer_list< double > &l)

void	set_time (const double *vals)

int	get_time (double *vals) const

void	set_time (const double &val_1)

int	get_time (double &val_1) const

void	set_calendar (const std::vector< std::string > &vals)

int	get_calendar (std::vector< std::string > &vals) const

void	set_calendar (const p_teca_variant_array &vals)

int	get_calendar (p_teca_variant_array vals) const

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

void	set_calendar (const std::string *vals)

int	get_calendar (std::string *vals) const

void	set_calendar (const std::string &val_1)

int	get_calendar (std::string &val_1) const

void	set_time_units (const std::vector< std::string > &vals)

int	get_time_units (std::vector< std::string > &vals) const

void	set_time_units (const p_teca_variant_array &vals)

int	get_time_units (p_teca_variant_array vals) const

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

void	set_time_units (const std::string *vals)

int	get_time_units (std::string *vals) const

void	set_time_units (const std::string &val_1)

int	get_time_units (std::string &val_1) const

void	set_time_step (const std::vector< unsigned long > &vals)

int	get_time_step (std::vector< unsigned long > &vals) const

void	set_time_step (const p_teca_variant_array &vals)

int	get_time_step (p_teca_variant_array vals) const

void	set_time_step (const std::initializer_list< unsigned long > &l)

void	set_time_step (const unsigned long *vals)

int	get_time_step (unsigned long *vals) const

void	set_time_step (const unsigned long &val_1)

int	get_time_step (unsigned long &val_1) const

void	set_attributes (const std::vector< teca_metadata > &vals)

int	get_attributes (std::vector< teca_metadata > &vals) const

void	set_attributes (const p_teca_variant_array &vals)

int	get_attributes (p_teca_variant_array vals) const

void	set_attributes (const std::initializer_list< teca_metadata > &l)

void	set_attributes (const teca_metadata *vals)

int	get_attributes (teca_metadata *vals) const

void	set_attributes (const teca_metadata &val_1)

int	get_attributes (teca_metadata &val_1) const

p_teca_array_collection &	get_arrays (int centering)

const_p_teca_array_collection	get_arrays (int centering) const

bool	empty () const noexcept override
	return true if the dataset is empty. More...

void	append_arrays (const const_p_teca_mesh &)

void	shallow_append_arrays (const p_teca_mesh &)

int	to_stream (teca_binary_stream &) const override

int	from_stream (teca_binary_stream &) override

int	to_stream (std::ostream &) const override
	stream to/from human readable representation More...

int	from_stream (std::istream &) override

p_teca_array_collection &	get_point_arrays ()

const_p_teca_array_collection	get_point_arrays () const

p_teca_array_collection &	get_cell_arrays ()

const_p_teca_array_collection	get_cell_arrays () const

p_teca_array_collection &	get_x_edge_arrays ()

const_p_teca_array_collection	get_x_edge_arrays () const

p_teca_array_collection &	get_y_edge_arrays ()

const_p_teca_array_collection	get_y_edge_arrays () const

p_teca_array_collection &	get_z_edge_arrays ()

const_p_teca_array_collection	get_z_edge_arrays () const

p_teca_array_collection &	get_x_face_arrays ()

const_p_teca_array_collection	get_x_face_arrays () const

p_teca_array_collection &	get_y_face_arrays ()

const_p_teca_array_collection	get_y_face_arrays () const

p_teca_array_collection &	get_z_face_arrays ()

const_p_teca_array_collection	get_z_face_arrays () const

p_teca_array_collection &	get_information_arrays ()

const_p_teca_array_collection	get_information_arrays () const

Public Member Functions inherited from teca_dataset
void	set_index_request_key (const std::vector< std::string > &vals)

int	get_index_request_key (std::vector< std::string > &vals) const

void	set_index_request_key (const p_teca_variant_array &vals)

int	get_index_request_key (p_teca_variant_array vals) const

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

void	set_index_request_key (const std::string *vals)

int	get_index_request_key (std::string *vals) const

void	set_index_request_key (const std::string &val_1)

int	get_index_request_key (std::string &val_1) const

virtual int	get_request_index (long &val) const

virtual int	set_request_index (const std::string &key, long val)

virtual int	set_request_index (long val)

	operator bool () const noexcept

virtual void	copy_metadata (const const_p_teca_dataset &other)

virtual teca_metadata &	get_metadata () noexcept

virtual const teca_metadata &	get_metadata () const noexcept

virtual void	set_metadata (const teca_metadata &md)

Static Public Member Functions
static p_teca_uniform_cartesian_mesh	New ()

Additional Inherited Members
Public Types inherited from teca_dataset
using	allocator = teca_variant_array::allocator

Public Attributes inherited from teca_mesh
std::shared_ptr< impl_t >	m_impl

Protected Member Functions inherited from teca_dataset
	teca_dataset (const teca_dataset &)=delete

	teca_dataset (const teca_dataset &&)=delete

void	operator= (const p_teca_dataset &other)=delete

void	operator= (p_teca_dataset &&other)=delete

Protected Attributes inherited from teca_dataset
teca_metadata *	metadata

Detailed Description

Data on a uniform cartesian mesh.

Member Function Documentation

◆ copy()

void teca_uniform_cartesian_mesh::copy	(	const const_p_teca_dataset &	other,
		allocator	alloc = `allocator::malloc`
	)

overridevirtual

Deep copy data and metdata.

Parameters

[in]	other	The dataset to copy.
[in]	alloc	The allocator to use for alloctions of data structures to hold the copy. The default is a CPU based allocator.

Reimplemented from teca_mesh.

◆ get_class_name()

std::string teca_uniform_cartesian_mesh::get_class_name ( ) const

inlineoverridevirtual

return a unique string identifier

Implements teca_dataset.

◆ get_number_of_cells()

unsigned long teca_uniform_cartesian_mesh::get_number_of_cells ( ) const

overridevirtual

get the number of cells in the mesh

Implements teca_mesh.

◆ get_number_of_points()

unsigned long teca_uniform_cartesian_mesh::get_number_of_points ( ) const

overridevirtual

get the number of points in the mesh

Implements teca_mesh.

◆ get_type_code()

int teca_uniform_cartesian_mesh::get_type_code ( ) const

overridevirtual

return a unique integer identifier

Implements teca_dataset.

◆ new_copy()

virtual p_teca_dataset teca_uniform_cartesian_mesh::new_copy ( allocator alloc = allocator::malloc ) const

inlineoverridevirtual

Implements teca_dataset.

◆ new_shallow_copy()

virtual p_teca_dataset teca_uniform_cartesian_mesh::new_shallow_copy ( )

inlineoverridevirtual

Virtual shallow copy constructor. return a shallow copy of this dataset in a new instance. References to source data structures are taken, but metadata is always deep copied.

Implements teca_dataset.

◆ shallow_copy()

void teca_uniform_cartesian_mesh::shallow_copy ( const p_teca_dataset & other )

overridevirtual

Shallow copy data and metadata. The shallow copy takes references to the source data structures. Metadata is always deep copied.

Parameters

[in] other The dataset to copy.

Reimplemented from teca_mesh.

◆ swap()

void teca_uniform_cartesian_mesh::swap ( const p_teca_dataset & )

overridevirtual

swap internals of the two objects

Reimplemented from teca_mesh.

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

stable/data/teca_uniform_cartesian_mesh.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ copy()

◆ get_class_name()

◆ get_number_of_cells()

◆ get_number_of_points()

◆ get_type_code()

◆ new_copy()

◆ new_shallow_copy()

◆ shallow_copy()

◆ swap()