psyclone.domain.lfric.kernel.inter_grid_vector_arg_metadata

Module containing the InterGridVectorArgMetadata class which captures the metadata associated with a intergrid vector argument. Supports the creation, modification and Fortran output of an InterGridVector argument.

Classes

class psyclone.domain.lfric.kernel.inter_grid_vector_arg_metadata.InterGridVectorArgMetadata(datatype, access, function_space, mesh_arg, vector_length, stencil=None)

Class to capture LFRic kernel metadata information for an InterGridVector argument.

Parameters:
  • datatype (str) – the datatype of this InterGridVector argument (GH_INTEGER, …).

  • access (str) – the way the kernel accesses this InterGridVector argument (GH_WRITE, …).

  • function_space (str) – the function space that this InterGridVector argument is on (W0, …).

  • mesh_arg (str) – the type of mesh that this InterGrid arg is on (coarse or fine).

  • vector_length (str) – the size of the vector.

  • stencil (Optional[str]) – the type of stencil used by the kernel when accessing this InterGrid arg.

Inheritance

Inheritance diagram of InterGridVectorArgMetadata
fortran_string()
Returns:

the metadata represented by this class as Fortran.

Return type:

str

property vector_length
Returns:

the vector length of this intergrid vector argument.

Return type:

str