read_icon_grid.h File Reference

#include "grids/basic_grid.h"
#include <mpi.h>

Include dependency graph for read_icon_grid.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
struct yac_basic_grid_data	yac_read_icon_basic_grid_data (char const *filename)
struct yac_basic_grid *	yac_read_icon_basic_grid (char const *filename, char const *gridname)
void	yac_read_icon_grid_information (const char *filename, int *num_vertices, int *num_cells, int **num_vertices_per_cell, int **cell_to_vertex, double **x_vertices, double **y_vertices, double **x_cells, double **y_cells, int **cell_mask)
void	yac_read_part_icon_grid_information (const char *filename, int *num_vertices, int *num_cells, int **num_vertices_per_cell, int **cell_to_vertex, double **x_vertices, double **y_vertices, double **x_cells, double **y_cells, int **global_cell_id, int **cell_mask, int **cell_core_mask, int **global_corner_id, int **corner_core_mask, int rank, int size)
void	yac_read_icon_grid_information_parallel (const char *filename, MPI_Comm comm, int *num_vertices, int *num_cells, int **num_vertices_per_cell, int **cell_to_vertex, int **global_cell_ids, int **cell_owner, int **global_vertex_ids, int **vertex_owner, double **x_vertices, double **y_vertices, double **x_cells, double **y_cells, int **cell_mask)
void	yac_read_icon_grid_information_parallel_2 (const char *filename, MPI_Comm comm, double **x_vertices, double **y_vertices, yac_int **cell_ids, yac_int **vertex_ids, yac_int **edge_ids, size_t *num_cells, size_t *num_vertices, size_t *num_edges, int **num_vertices_per_cell, int **num_cells_per_vertex, size_t **cell_to_vertex, size_t **cell_to_edge, size_t **vertex_to_cell, size_t **edge_to_vertex, enum yac_edge_type **edge_type, double **x_cells, double **y_cells, int **cell_mask)
struct yac_basic_grid_data	yac_read_icon_basic_grid_data_parallel (const char *filename, MPI_Comm comm)
struct yac_basic_grid *	yac_read_icon_basic_grid_parallel (char const *filename, char const *gridname, MPI_Comm comm)
void	yac_read_icon_basic_grid_parallel_2 (char const *filename, char const *gridname, MPI_Comm comm, struct yac_basic_grid **grid, size_t *cell_coordinate_idx, int **cell_mask)
void	yac_delete_icon_grid_data (int **cell_mask, int **global_cell_id, int **cell_core_mask, int **num_vertices_per_cell, int **global_corner_id, int **corner_core_mask, int **cell_to_vertex, double **x_cells, double **y_cells, double **x_vertices, double **y_vertices)

Function Documentation

yac_delete_icon_grid_data()

void yac_delete_icon_grid_data	(	int **	cell_mask,
		int **	global_cell_id,
		int **	cell_core_mask,
		int **	num_vertices_per_cell,
		int **	global_corner_id,
		int **	corner_core_mask,
		int **	cell_to_vertex,
		double **	x_cells,
		double **	y_cells,
		double **	x_vertices,
		double **	y_vertices )

destroys remaining icon grid data

Parameters

[out]	cell_mask	mask for cells
[out]	global_cell_id	global cell IDs
[out]	cell_core_mask	cell core mask
[out]	num_vertices_per_cell	number of vertices per cell
[out]	global_corner_id	global corner IDs
[out]	corner_core_mask	corner core mask
[out]	cell_to_vertex	vertex indices for each cell
[out]	x_cells	longitudes of cell center
[out]	y_cells	latitudes of cell center
[out]	x_vertices	longitudes of vertices
[out]	y_vertices	latitudes of vertices

Definition at line 1830 of file read_icon_grid.c.

yac_read_icon_basic_grid()

struct yac_basic_grid * yac_read_icon_basic_grid	(	char const *	filename,
		char const *	gridname )

Reads in an icon grid netcdf file and generates a yac_basic_grid from it.

Parameters

[in]	filename	name of the icon grid netcdf file
[in]	gridname	name of the grid

Returns

yac_basic_grid structure that contains the icon grid

Definition at line 1749 of file read_icon_grid.c.

Here is the call graph for this function:

yac_read_icon_basic_grid_data()

struct yac_basic_grid_data yac_read_icon_basic_grid_data

(

char const *

filename

)

Reads in an icon grid netcdf file and generates a yac_basic_grid_data from it.

Parameters

[in]

filename

name of the icon grid netcdf file

Returns

yac_basic_grid_data that contains the icon grid

Definition at line 1713 of file read_icon_grid.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_read_icon_basic_grid_data_parallel()

struct yac_basic_grid_data yac_read_icon_basic_grid_data_parallel	(	const char *	filename,
		MPI_Comm	comm )

Reads in an icon grid netcdf file in parallel and returns a yac_basic_grid_data built from it.

Parameters

[in]	filename	name of the icon grid netcdf file
[in]	comm	MPI communicator containing all proceses that will get a part of the grid

Returns

yac_basic_grid_data structure containing part of the icon grid.

Remarks

The data of each process contains no halo cells.

See also

Configuration of parallel IO in YAC

Definition at line 1562 of file read_icon_grid.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_read_icon_basic_grid_parallel()

struct yac_basic_grid * yac_read_icon_basic_grid_parallel	(	char const *	filename,
		char const *	gridname,
		MPI_Comm	comm )

Reads in an icon grid netcdf file in parallel and returns a yac_basic_grid built from it.

Parameters

[in]	filename	name of the icon grid netcdf file
[in]	gridname	name of grid
[in]	comm	MPI communicator containing all proceses that will get a part of the grid

Returns

yac_basic_grid structure containing part of the icon grid.

Remarks

The data of each process contains no halo cells.

See also

Configuration of parallel IO in YAC

Definition at line 1696 of file read_icon_grid.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_read_icon_basic_grid_parallel_2()

void yac_read_icon_basic_grid_parallel_2	(	char const *	filename,
		char const *	gridname,
		MPI_Comm	comm,
		struct yac_basic_grid **	grid,
		size_t *	cell_coordinate_idx,
		int **	cell_mask )

Reads in an icon grid netcdf file in parallel and returns a yac_basic_grid built from it.

Parameters

[in]	filename	name of the icon grid netcdf file
[in]	gridname	name of grid
[in]	comm	MPI communicator containing all proceses that will get a part of the grid
[out]	grid	yac_basic_grid structure containing part of the icon grid.
[out]	cell_coordinate_idx	points index at which the cell centers are registerd in the grid
[out]	cell_mask	mask for local cells (variable cell_sea_land_mask in icon grid file)

Remarks

If (cell_coordinate_idx == NULL) no cell center coordinates will be read.

If (cell_mask == NULL) no cell mask information will be read.

The data of each process contains no halo cells.

See also

Configuration of parallel IO in YAC

Definition at line 1622 of file read_icon_grid.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_read_icon_grid_information()

void yac_read_icon_grid_information	(	const char *	filename,
		int *	num_vertices,
		int *	num_cells,
		int **	num_vertices_per_cell,
		int **	cell_to_vertex,
		double **	x_vertices,
		double **	y_vertices,
		double **	x_cells,
		double **	y_cells,
		int **	cell_mask )

Reads in an icon grid netcdf file and return the grid information in a format that is supported by the YAC user interface.

Parameters

[in]	filename	name of the icon grid netcdf file
[out]	num_vertices	number of vertices in the grid
[out]	num_cells	number of cells in the grid
[out]	num_vertices_per_cell	number of vertices per cell
[out]	cell_to_vertex	vertex indices for each cell
[out]	x_vertices	longitudes of vertices
[out]	y_vertices	latitudes of vertices
[out]	x_cells	longitudes of cell center
[out]	y_cells	latitudes of cell center
[out]	cell_mask	mask for cells

Definition at line 184 of file read_icon_grid.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_read_icon_grid_information_parallel()

void yac_read_icon_grid_information_parallel	(	const char *	filename,
		MPI_Comm	comm,
		int *	num_vertices,
		int *	num_cells,
		int **	num_vertices_per_cell,
		int **	cell_to_vertex,
		int **	global_cell_ids,
		int **	cell_owner,
		int **	global_vertex_ids,
		int **	vertex_owner,
		double **	x_vertices,
		double **	y_vertices,
		double **	x_cells,
		double **	y_cells,
		int **	cell_mask )

Reads in an icon grid netcdf file and returns the grid information in a format that is supported by the YAC user interface. The reading is done in parallel and a basic domain decomposition is applied.

Parameters

[in]	filename	name of the icon grid netcdf file
[in]	comm	MPI communicator containing all proceses that will get a part of the grid
[out]	num_vertices	number of vertices in the local part of the grid
[out]	num_cells	number of cells in the local part of the grid
[out]	num_vertices_per_cell	number of vertices per cell
[out]	cell_to_vertex	vertex indices for each cell
[out]	global_cell_ids	global ids of local cells (core and halo cells)
[out]	cell_owner	owner of each cell (locally owned cells are marked with -1)
[out]	global_vertex_ids	global ids of local vertices (core and halo vertices)
[out]	vertex_owner	owner of each vertex (locally owned vertices are marked with -1)
[out]	x_vertices	longitudes of vertices
[out]	y_vertices	latitudes of vertices
[out]	x_cells	longitudes of cell center
[out]	y_cells	latitudes of cell center
[out]	cell_mask	mask for cells (variable cell_sea_land_mask in icon grid file)

Remarks

The data of each process contains one layer of halo cells.

If (x_cells == NULL) && (y_cells == NULL) no cell center coordinates will be read.

If (cell_mask == NULL) no cell mask information will be read.

See also

Configuration of parallel IO in YAC

Definition at line 251 of file read_icon_grid.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_read_icon_grid_information_parallel_2()

void yac_read_icon_grid_information_parallel_2	(	const char *	filename,
		MPI_Comm	comm,
		double **	x_vertices,
		double **	y_vertices,
		yac_int **	cell_ids,
		yac_int **	vertex_ids,
		yac_int **	edge_ids,
		size_t *	num_cells,
		size_t *	num_vertices,
		size_t *	num_edges,
		int **	num_vertices_per_cell,
		int **	num_cells_per_vertex,
		size_t **	cell_to_vertex,
		size_t **	cell_to_edge,
		size_t **	vertex_to_cell,
		size_t **	edge_to_vertex,
		enum yac_edge_type **	edge_type,
		double **	x_cells,
		double **	y_cells,
		int **	cell_mask )

Reads in an icon grid netcdf file and returns the grid information in a format that allows the user to set up a yac_basic_grid_data structure. The reading is done in parallel and a basic domain decomposition is applied.

Parameters

[in]	filename	name of the icon grid netcdf file
[in]	comm	MPI communicator containing all proceses that will get a part of the grid
[out]	x_vertices	longitudes of vertices
[out]	y_vertices	latitudes of vertices
[out]	cell_ids	global ids of local cells
[out]	vertex_ids	global ids of local vertices
[out]	edge_ids	global ids of local edges
[out]	num_cells	number of cells in the local part of the grid
[out]	num_vertices	number of vertices in the local part of the grid
[out]	num_edges	number of edges in the local part of the grid
[out]	num_vertices_per_cell	number of vertices per cell
[out]	num_cells_per_vertex	number of cells per vertex
[out]	cell_to_vertex	local vertex indices for each local cell
[out]	cell_to_edge	local edge indices for each local cell
[out]	vertex_to_cell	local cell indices for each local vertex
[out]	edge_to_vertex	local vertex indices for each local edge
[out]	edge_type	type of each local edge
[out]	x_cells	longitudes of local cell centers
[out]	y_cells	latitudes of local cell centers
[out]	cell_mask	mask for local cells (variable cell_sea_land_mask in icon grid file)

Remarks

The data of each process contains no halo cells.

If (x_cells == NULL) && (y_cells == NULL) no cell center coordinates will be read.

If (cell_mask == NULL) no cell mask information will be read.

See also

Configuration of parallel IO in YAC

Definition at line 961 of file read_icon_grid.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_read_part_icon_grid_information()

void yac_read_part_icon_grid_information	(	const char *	filename,
		int *	num_vertices,
		int *	num_cells,
		int **	num_vertices_per_cell,
		int **	cell_to_vertex,
		double **	x_vertices,
		double **	y_vertices,
		double **	x_cells,
		double **	y_cells,
		int **	global_cell_id,
		int **	cell_mask,
		int **	cell_core_mask,
		int **	global_corner_id,
		int **	corner_core_mask,
		int	rank,
		int	size )

Reads in an icon grid netcdf file and return the grid information in a format that is supported by the YAC user interface.

Parameters

[in]	filename	name of the icon grid netcdf file
[out]	num_vertices	number of vertices in the grid
[out]	num_cells	number of cells in the grid
[out]	num_vertices_per_cell	number of vertices per cell
[out]	cell_to_vertex	vertex indices for each cell
[out]	x_vertices	longitudes of vertices
[out]	y_vertices	latitudes of vertices
[out]	x_cells	longitudes of cell center
[out]	y_cells	latitudes of cell center
[out]	global_cell_id	global cell IDs
[out]	cell_mask	mask for cells
[out]	cell_core_mask	cell core mask
[out]	global_corner_id	global corner IDs
[out]	corner_core_mask	corner core mask
[out]	rank	local MPI rank
[out]	size	number of MPI ranks

Remarks

The process reads in the fields of the whole grid and then extracts parts of it based on the "rank" and "size" parameter.

Definition at line 31 of file read_icon_grid.c.

Here is the call graph for this function:

Here is the caller graph for this function: