psyclone.domain.lfric.kernel.operator_arg_metadata

Module containing the OperatorArgMetadata class which captures the metadata associated with an operator argument. Supports the creation, modification and Fortran output of a Operator argument.

Classes

class psyclone.domain.lfric.kernel.operator_arg_metadata.OperatorArgMetadata(datatype, access, function_space_to, function_space_from)

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

Parameters:

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

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

  • function_space_to (str) – the function space that this operator maps to (W0, …).

  • function_space_from (str) – the function space that this operator maps from (W0, …).

Inheritance

Inheritance diagram of OperatorArgMetadata
static check_access(value)
Parameters:

value (str) – the access descriptor to validate.

static check_datatype(value)
Parameters:

value (str) – the datatype to check for validity.

fortran_string()
Returns:

the metadata represented by this class as Fortran.

Return type:

str

property function_space_from
Returns:

the second function space for this operator argument (that this operator maps from).

Return type:

str

property function_space_to
Returns:

the first function space for this operator argument (that this operator maps to).

Return type:

str