src.core.BasicGrid Class Reference

Collaboration diagram for src.core.BasicGrid:

Public Member Functions
	__init__ (self, yac_basic_grid_ptr)
	__del__ (self)
	to_file (self, filename, comm=None)
	name (self)
	__str__ (self)
	get_data_size (self, yac_location location)
	set_global_index (self, yac_location location, indices)
	set_core_mask (self, yac_location location, mask)
	add_coordinates (self, yac_location location, lon=None, lat=None)
	add_mask (self, yac_location location, mask, str|None mask_name=None)
	check_coordinates (self, bool is_fatal=True)
	read_icon (cls, str filename, str gridname, comm=None, mask_valid_values=None)
	read_scrip (cls, grid_filename, mask_filename, grid_name, name, valid_mask_value=1, use_ll_edges=False)
	reg_2d_new (cls, name, lon_vertices, lat_vertices, cyclic=[False, False])
	unstruct_new (cls, str name, num_vertices_per_cell, x_vertices, y_vertices, cell_to_vertex, lonlat_edges=False)
	unstruct_edge_new (cls, str name, num_edges_per_cell, x_vertices, y_vertices, cell_to_edge, edge_to_vertex, bool lonlat_edges=False)
	empty (cls, str name)
	from_uxgrid (cls, str name, uxgrid, bool def_edges=False, bool lonlat_edges=False)

Static Public Attributes
	basic_grid

Static Protected Attributes
	_ptr

Detailed Description

Definition at line 449 of file core.pyx.

Constructor & Destructor Documentation

__init__()

src.core.BasicGrid.__init__	(		self,
			yac_basic_grid_ptr )

Definition at line 452 of file core.pyx.

__del__()

src.core.BasicGrid.__del__

(

self

)

Definition at line 455 of file core.pyx.

Here is the call graph for this function:

Member Function Documentation

__str__()

src.core.BasicGrid.__str__

(

self

)

Definition at line 481 of file core.pyx.

add_coordinates()

src.core.BasicGrid.add_coordinates	(		self,
		yac_location	location,
			lon = None,
			lat = None )

Definition at line 530 of file core.pyx.

Here is the call graph for this function:

add_mask()

src.core.BasicGrid.add_mask	(		self,
		yac_location	location,
			mask,
		str | None	mask_name = None )

Definition at line 552 of file core.pyx.

Here is the call graph for this function:

check_coordinates()

src.core.BasicGrid.check_coordinates	(		self,
		bool	is_fatal = True )

Definition at line 569 of file core.pyx.

Here is the call graph for this function:

empty()

src.core.BasicGrid.empty	(		cls,
		str	name )

Definition at line 766 of file core.pyx.

Here is the call graph for this function:

from_uxgrid()

src.core.BasicGrid.from_uxgrid	(		cls,
		str	name,
			uxgrid,
		bool	def_edges = False,
		bool	lonlat_edges = False )

Definition at line 772 of file core.pyx.

Here is the call graph for this function:

get_data_size()

src.core.BasicGrid.get_data_size	(		self,
		yac_location	location )

Definition at line 484 of file core.pyx.

Here is the call graph for this function:

Here is the caller graph for this function:

name()

src.core.BasicGrid.name

(

self

)

Definition at line 477 of file core.pyx.

Here is the call graph for this function:

read_icon()

src.core.BasicGrid.read_icon	(		cls,
		str	filename,
		str	gridname,
			comm = None,
			mask_valid_values = None )

Definition at line 574 of file core.pyx.

Here is the call graph for this function:

read_scrip()

src.core.BasicGrid.read_scrip	(		cls,
			grid_filename,
			mask_filename,
			grid_name,
			name,
			valid_mask_value = 1,
			use_ll_edges = False )

Definition at line 610 of file core.pyx.

Here is the call graph for this function:

reg_2d_new()

src.core.BasicGrid.reg_2d_new	(		cls,
			name,
			lon_vertices,
			lat_vertices,
			cyclic = [False, False] )

Definition at line 655 of file core.pyx.

Here is the call graph for this function:

set_core_mask()

src.core.BasicGrid.set_core_mask	(		self,
		yac_location	location,
			mask )

Definition at line 510 of file core.pyx.

Here is the call graph for this function:

set_global_index()

src.core.BasicGrid.set_global_index	(		self,
		yac_location	location,
			indices )

Definition at line 488 of file core.pyx.

Here is the call graph for this function:

to_file()

src.core.BasicGrid.to_file	(		self,
			filename,
			comm = None )

Definition at line 465 of file core.pyx.

Here is the call graph for this function:

unstruct_edge_new()

src.core.BasicGrid.unstruct_edge_new	(		cls,
		str	name,
			num_edges_per_cell,
			x_vertices,
			y_vertices,
			cell_to_edge,
			edge_to_vertex,
		bool	lonlat_edges = False )

Definition at line 717 of file core.pyx.

Here is the call graph for this function:

Here is the caller graph for this function:

unstruct_new()

src.core.BasicGrid.unstruct_new	(		cls,
		str	name,
			num_vertices_per_cell,
			x_vertices,
			y_vertices,
			cell_to_vertex,
			lonlat_edges = False )

Definition at line 672 of file core.pyx.

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

_ptr

src.core.BasicGrid._ptr

staticprotected

Definition at line 462 of file core.pyx.

basic_grid

src.core.BasicGrid.basic_grid

static

Definition at line 461 of file core.pyx.

---

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

• python/src/core.pyx