psyclone.domain.lfric.kernel.operates_on_metadata
Module containing the OperatesOnMetadata class which captures the values for the LFRic kernel OPERATES_ON metadata.
Classes
OperatesOnMetadata
: Class to capture the values of the LFRic kernel
- class psyclone.domain.lfric.kernel.operates_on_metadata.OperatesOnMetadata(operates_on)
Class to capture the values of the LFRic kernel OPERATES_ON metadata. This class supports the creation, modification and Fortran output of this metadata.
OPERATES_ON metadata specifies that the Kernel has been written to expect data in the specified form, i.e. ‘cell_column’ means a column of cells and ‘domain’ means all cells.
- Parameters:
operates_on (str) – the value of operates_on.
Inheritance
- static create_from_fparser2(fparser2_tree)
Create an instance of OperatesOnMetadata from an fparser2 tree.
- Parameters:
fparser2_tree (
fparser.two.Fortran2003. Data_Component_Def_Stmt
) – fparser2 tree capturing the operates_on metadata.
LFRic operates_on metadata is in scalar form:
integer :: operates_on = cell_column
- Returns:
an instance of OperatesOnMetadata.
- Return type:
psyclone.domain.lfric.kernel. OperatesOnMetadata
- fortran_string()
- Returns:
the operates_on metadata as Fortran.
- Return type:
str
- property operates_on
- Returns:
the operates_on value.
- Return type:
str