psyclone.domain.lfric.kernel.meta_funcs_arg_metadata
Module containing the MetaFuncsArgMetadata class which captures the argument values for the LFRic kernel META_FUNCS metadata.
Classes
MetaFuncsArgMetadata
: Class to capture the LFRic kernel metadata information for a
- class psyclone.domain.lfric.kernel.meta_funcs_arg_metadata.MetaFuncsArgMetadata(function_space, basis_function=False, diff_basis_function=False)
Class to capture the LFRic kernel metadata information for a meta_funcs argument.
- Parameters:
function_space (str) – the name of a function space.
basis_function (bool) – whether a basis_function is required. Defaults to False.
diff_basis_function (bool) – whether a differential basis function is required. Defaults to False.
Inheritance
- property basis_function
- Returns:
whether a basis function is required for this function space, or not.
- Return type:
bool
- static create_from_fparser2(fparser2_tree)
Create an instance of this class from an fparser2 tree.
- Parameters:
fparser2_tree (
fparser.two.Fortran2003.Part_Ref
) – fparser2 tree containing the metadata for a meta_funcs argument.- Returns:
an instance of this class.
- Return type:
psyclone.domain.lfric.kernel.MetaFuncsArgMetadata
- property diff_basis_function
- Returns:
whether a differential basis function is required for this function space, or not.
- Return type:
bool
- fortran_string()
- Returns:
the metadata represented by this class as Fortran.
- Return type:
str
- property function_space
- Returns:
the function space for this meta_funcs argument.
- Return type:
str