psyclone.domain.lfric.kernel.field_vector_arg_metadata

Module containing the FieldVector Arg class which captures the metadata associated with a field vector argument. Supports the creation, modification and Fortran output of a Field Vector argument.

Classes

class psyclone.domain.lfric.kernel.field_vector_arg_metadata.FieldVectorArgMetadata(datatype, access, function_space, vector_length, stencil=None)

Class to capture LFRic kernel metadata information for a field vector argument.

Parameters:

  • datatype (str) – the datatype of this field (GH_INTEGER, …).

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

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

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

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

Inheritance

Inheritance diagram of FieldVectorArgMetadata
fortran_string()
Returns:

the metadata represented by this class as Fortran.

Return type:

str

property vector_length
Returns:

the vector length of this field vector argument.

Return type:

str