YetAnotherCoupler 3.2.0_a
Loading...
Searching...
No Matches
Public Member Functions
yac::yac_fdef_grid Interface Reference

Fortran interface for the definition of grids. More...

Collaboration diagram for yac::yac_fdef_grid:
Collaboration graph

Public Member Functions

subroutine yac_fdef_grid_nonuniform_real (grid_name, nbr_vertices, nbr_cells, nbr_connections, nbr_vertices_per_cell, x_vertices, y_vertices, cell_to_vertex, grid_id, use_ll_edges)
 Definition of a non-uniform unstructured grid (cells have varying numbers of vertices)
 
subroutine yac_fdef_grid_nonuniform_dble (grid_name, nbr_vertices, nbr_cells, nbr_connections, nbr_vertices_per_cell, x_vertices, y_vertices, cell_to_vertex, grid_id, use_ll_edges)
 Definition of a non-uniform unstructured grid (cells have varying numbers of vertices)
 
subroutine yac_fdef_grid_unstruct_real (grid_name, nbr_vertices, nbr_cells, nbr_vertices_per_cell, x_vertices, y_vertices, cell_to_vertex, grid_id, use_ll_edges)
 Definition of a uniform unstructured grid (all cells have the number of vertices)
 
subroutine yac_fdef_grid_unstruct_dble (grid_name, nbr_vertices, nbr_cells, nbr_vertices_per_cell, x_vertices, y_vertices, cell_to_vertex, grid_id, use_ll_edges)
 Definition of a uniform unstructured grid (all cells have the number of vertices)
 
subroutine yac_fdef_grid_curve2d_real (grid_name, nbr_vertices, cyclic, x_vertices, y_vertices, grid_id)
 Definition of a 2d curvilinear grid.
 
subroutine yac_fdef_grid_curve2d_dble (grid_name, nbr_vertices, cyclic, x_vertices, y_vertices, grid_id)
 Definition of a 2d curvilinear grid.
 
subroutine yac_fdef_grid_reg2d_real (grid_name, nbr_vertices, cyclic, x_vertices, y_vertices, grid_id)
 Definition of a 2d regular grid.
 
subroutine yac_fdef_grid_reg2d_dble (grid_name, nbr_vertices, cyclic, x_vertices, y_vertices, grid_id)
 Definition of a 2d regular grid.
 

Detailed Description

Fortran interface for the definition of grids.

Definition at line 557 of file yac_module.F90.

Member Function/Subroutine Documentation

◆ yac_fdef_grid_curve2d_dble()

subroutine yac::yac_fdef_grid::yac_fdef_grid_curve2d_dble ( character(len=*), intent(in)  grid_name,
integer, dimension(2), intent(in)  nbr_vertices,
integer, dimension(2), intent(in)  cyclic,
double precision, dimension(nbr_vertices(1),nbr_vertices(2)), intent(in)  x_vertices,
double precision, dimension(nbr_vertices(1),nbr_vertices(2)), intent(in)  y_vertices,
integer, intent(out)  grid_id 
)

Definition of a 2d curvilinear grid.

Parameters
[in]grid_namegrid name
[in]nbr_verticesnumber of cells in each dimension
[in]cycliccyclic behavior of cells in each dimension
[in]x_verticeslongitudes of vertices
[in]y_verticeslatitudes of vertices
[out]grid_idgrid identifier

Definition at line 759 of file yac_module.F90.

◆ yac_fdef_grid_curve2d_real()

subroutine yac::yac_fdef_grid::yac_fdef_grid_curve2d_real ( character(len=*), intent(in)  grid_name,
integer, dimension(2), intent(in)  nbr_vertices,
integer, dimension(2), intent(in)  cyclic,
real, dimension(nbr_vertices(1),nbr_vertices(2)), intent(in)  x_vertices,
real, dimension(nbr_vertices(1),nbr_vertices(2)), intent(in)  y_vertices,
integer, intent(out)  grid_id 
)

Definition of a 2d curvilinear grid.

Parameters
[in]grid_namegrid name
[in]nbr_verticesnumber of cells in each dimension
[in]cycliccyclic behavior of cells in each dimension
[in]x_verticeslongitudes of vertices
[in]y_verticeslatitudes of vertices
[out]grid_idgrid identifier

Definition at line 734 of file yac_module.F90.

◆ yac_fdef_grid_nonuniform_dble()

subroutine yac::yac_fdef_grid::yac_fdef_grid_nonuniform_dble ( character(len=*), intent(in)  grid_name,
integer, intent(in)  nbr_vertices,
integer, intent(in)  nbr_cells,
integer, intent(in)  nbr_connections,
integer, dimension(nbr_cells), intent(in)  nbr_vertices_per_cell,
double precision, dimension(nbr_vertices), intent(in)  x_vertices,
double precision, dimension(nbr_vertices), intent(in)  y_vertices,
integer, dimension(nbr_connections), intent(in)  cell_to_vertex,
integer, intent(out)  grid_id,
logical, intent(in), optional  use_ll_edges 
)

Definition of a non-uniform unstructured grid (cells have varying numbers of vertices)

Parameters
[in]grid_namegrid name
[in]nbr_verticesnumber of vertices
[in]nbr_cellsnumber of cells
[in]nbr_connectionstotal size of cell_to_vertex
[in]nbr_vertices_per_cellnumber of vertices for each cell
[in]x_verticeslongitudes of vertices
[in]y_verticeslatitudes of vertices
[in]cell_to_vertexconnectivity between vertices and cells
(the vertex indices per cell have to be in clockwise or counterclockwise ordering)
[out]grid_idgrid identifier
[in]use_ll_edgesuse lonlat edges
Remarks
If (use_ll_edges == .TRUE.) YAC will check all edges of the grid and determine whether they are on circles of longitudes (same x coordinate) or latitudes (same y coordinate). An edge that does not fullfill this condition will cause an error.

Definition at line 621 of file yac_module.F90.

◆ yac_fdef_grid_nonuniform_real()

subroutine yac::yac_fdef_grid::yac_fdef_grid_nonuniform_real ( character(len=*), intent(in)  grid_name,
integer, intent(in)  nbr_vertices,
integer, intent(in)  nbr_cells,
integer, intent(in)  nbr_connections,
integer, dimension(nbr_cells), intent(in)  nbr_vertices_per_cell,
real, dimension(nbr_vertices), intent(in)  x_vertices,
real, dimension(nbr_vertices), intent(in)  y_vertices,
integer, dimension(nbr_connections), intent(in)  cell_to_vertex,
integer, intent(out)  grid_id,
logical, intent(in), optional  use_ll_edges 
)

Definition of a non-uniform unstructured grid (cells have varying numbers of vertices)

Parameters
[in]grid_namegrid name
[in]nbr_verticesnumber of vertices
[in]nbr_cellsnumber of cells
[in]nbr_connectionstotal size of cell_to_vertex
[in]nbr_vertices_per_cellnumber of vertices for each cell
[in]x_verticeslongitudes of vertices
[in]y_verticeslatitudes of vertices
[in]cell_to_vertexconnectivity between vertices and cells
(the vertex indices per cell have to be in clockwise or counterclockwise ordering)
[out]grid_idgrid identifier
[in]use_ll_edgesuse lonlat edges
Remarks
If (use_ll_edges == .TRUE.) YAC will check all edges of the grid and determine whether they are on circles of longitudes (same x coordinate) or latitudes (same y coordinate). An edge that does not fullfill this condition will cause an error.

Definition at line 578 of file yac_module.F90.

◆ yac_fdef_grid_reg2d_dble()

subroutine yac::yac_fdef_grid::yac_fdef_grid_reg2d_dble ( character(len=*), intent(in)  grid_name,
integer, dimension(2), intent(in)  nbr_vertices,
integer, dimension(2), intent(in)  cyclic,
double precision, dimension(nbr_vertices(1)), intent(in)  x_vertices,
double precision, dimension(nbr_vertices(2)), intent(in)  y_vertices,
integer, intent(out)  grid_id 
)

Definition of a 2d regular grid.

Parameters
[in]grid_namegrid name
[in]nbr_verticesnumber of cells in each dimension
[in]cycliccyclic behavior of cells in each dimension
[in]x_verticeslongitudes of vertices
[in]y_verticeslatitudes of vertices
[out]grid_idgrid identifier

Definition at line 807 of file yac_module.F90.

◆ yac_fdef_grid_reg2d_real()

subroutine yac::yac_fdef_grid::yac_fdef_grid_reg2d_real ( character(len=*), intent(in)  grid_name,
integer, dimension(2), intent(in)  nbr_vertices,
integer, dimension(2), intent(in)  cyclic,
real, dimension(nbr_vertices(1)), intent(in)  x_vertices,
real, dimension(nbr_vertices(2)), intent(in)  y_vertices,
integer, intent(out)  grid_id 
)

Definition of a 2d regular grid.

Parameters
[in]grid_namegrid name
[in]nbr_verticesnumber of cells in each dimension
[in]cycliccyclic behavior of cells in each dimension
[in]x_verticeslongitudes of vertices
[in]y_verticeslatitudes of vertices
[out]grid_idgrid identifier

Definition at line 784 of file yac_module.F90.

◆ yac_fdef_grid_unstruct_dble()

subroutine yac::yac_fdef_grid::yac_fdef_grid_unstruct_dble ( character(len=*), intent(in)  grid_name,
integer, intent(in)  nbr_vertices,
integer, intent(in)  nbr_cells,
integer, intent(in)  nbr_vertices_per_cell,
double precision, dimension(nbr_vertices), intent(in)  x_vertices,
double precision, dimension(nbr_vertices), intent(in)  y_vertices,
integer, dimension( nbr_vertices_per_cell,nbr_cells), intent(in)  cell_to_vertex,
integer, intent(out)  grid_id,
logical, intent(in), optional  use_ll_edges 
)

Definition of a uniform unstructured grid (all cells have the number of vertices)

Parameters
[in]grid_namegrid name
[in]nbr_verticesnumber of vertices
[in]nbr_cellsnumber of cells
[in]nbr_vertices_per_cellnumber of vertices for each cell
[in]x_verticeslongitudes of vertices
[in]y_verticeslatitudes of vertices
[in]cell_to_vertexconnectivity between vertices and cells
(the vertex indices per cell have to be in clockwise or counterclockwise ordering)
[out]grid_idgrid identifier
[in]use_ll_edgesuse lonlat edges
Remarks
If (use_ll_edges == .TRUE.) YAC will check all edges of the grid and determine whether they are on circles of longitudes (same x coordinate) or latitudes (same y coordinate). An edge that does not fullfill this condition will cause an error.

Definition at line 704 of file yac_module.F90.

◆ yac_fdef_grid_unstruct_real()

subroutine yac::yac_fdef_grid::yac_fdef_grid_unstruct_real ( character(len=*), intent(in)  grid_name,
integer, intent(in)  nbr_vertices,
integer, intent(in)  nbr_cells,
integer, intent(in)  nbr_vertices_per_cell,
real, dimension(nbr_vertices), intent(in)  x_vertices,
real, dimension(nbr_vertices), intent(in)  y_vertices,
integer, dimension( nbr_vertices_per_cell,nbr_cells), intent(in)  cell_to_vertex,
integer, intent(out)  grid_id,
logical, intent(in), optional  use_ll_edges 
)

Definition of a uniform unstructured grid (all cells have the number of vertices)

Parameters
[in]grid_namegrid name
[in]nbr_verticesnumber of vertices
[in]nbr_cellsnumber of cells
[in]nbr_vertices_per_cellnumber of vertices for each cell
[in]x_verticeslongitudes of vertices
[in]y_verticeslatitudes of vertices
[in]cell_to_vertexconnectivity between vertices and cells
(the vertex indices per cell have to be in clockwise or counterclockwise ordering)
[out]grid_idgrid identifier
[in]use_ll_edgesuse lonlat edges
Remarks
If (use_ll_edges == .TRUE.) YAC will check all edges of the grid and determine whether they are on circles of longitudes (same x coordinate) or latitudes (same y coordinate). An edge that does not fullfill this condition will cause an error.

Definition at line 663 of file yac_module.F90.


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