psyclone.domain.lfric.kernel.scalar_arg_metadata.ScalarArgMetadata Class Reference

Inheritance diagram for psyclone.domain.lfric.kernel.scalar_arg_metadata.ScalarArgMetadata:

Collaboration diagram for psyclone.domain.lfric.kernel.scalar_arg_metadata.ScalarArgMetadata:

Public Member Functions
def	fortran_string (self)
Public Member Functions inherited from psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata
def	__init__ (self, datatype, access)
def	create_from_fparser2 (cls, fparser2_tree)
def	check_first_arg (cls, fparser2_tree)
def	check_remaining_args (cls, fparser2_tree, *metadata_args)
def	check_nargs (cls, fparser2_tree)
def	get_vector_length (cls, fparser2_tree)
def	datatype (self)
def	datatype (self, value)
def	access (self)
def	access (self, value)
Public Member Functions inherited from psyclone.domain.lfric.kernel.common_arg_metadata.CommonArgMetadata
def	check_fparser2_arg (cls, fparser2_tree, type_name)
Public Member Functions inherited from psyclone.domain.lfric.kernel.common_metadata.CommonMetadata
def	create_from_fortran_string (cls, fortran_string)

Static Public Member Functions
def	check_datatype (value)
def	check_access (value)
Static Public Member Functions inherited from psyclone.domain.lfric.kernel.common_arg_metadata.CommonArgMetadata
def	check_boolean (value, name)
def	get_nargs (fparser2_tree)
def	get_arg (fparser2_tree, index)
Static Public Member Functions inherited from psyclone.domain.lfric.kernel.common_metadata.CommonMetadata
def	check_fparser2 (fparser2_tree, encoding)
def	validate_scalar_value (value, valid_values, name)
def	create_fparser2 (fortran_string, encoding)
def	create_from_fparser2 (fparser2_tree)

Static Public Attributes
string	form = "gh_scalar"
int	form_arg_index = 0
int	datatype_arg_index = 1
int	access_arg_index = 2
string	check_name = "scalar"
int	nargs = 3
Static Public Attributes inherited from psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata
bool	vector = False
int	form_arg_index = 0
int	vector_length_arg_index = 0
int	datatype_arg_index = 1
int	access_arg_index = 2
int	function_space_arg_index = 3
string	form = ""
string	check_name = ""
int	nargs = 1
Static Public Attributes inherited from psyclone.domain.lfric.kernel.common_arg_metadata.CommonArgMetadata
	fparser2_class = Fortran2003.Part_Ref
Static Public Attributes inherited from psyclone.domain.lfric.kernel.common_metadata.CommonMetadata
	fparser2_class = None

Additional Inherited Members
Public Attributes inherited from psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata
	datatype
	access

Detailed Description

Class to capture LFRic kernel metadata information for a scalar
argument.

Definition at line 46 of file scalar_arg_metadata.py.

Member Function Documentation

check_access()

def psyclone.domain.lfric.kernel.scalar_arg_metadata.ScalarArgMetadata.check_access (   value )

static

:param str value: the access descriptor to validate.

Reimplemented from psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata.

Reimplemented in psyclone.domain.lfric.kernel.operator_arg_metadata.OperatorArgMetadata, and psyclone.domain.lfric.kernel.field_arg_metadata.FieldArgMetadata.

Definition at line 121 of file scalar_arg_metadata.py.

    def check_access(value):
        '''
        :param str value: the access descriptor to validate.
        '''
        const = LFRicConstants()
        ScalarArgMetadata.validate_scalar_value(
            value, const.VALID_SCALAR_ACCESS_TYPES, "access descriptor")
 
 

Here is the caller graph for this function:

check_datatype()

def psyclone.domain.lfric.kernel.scalar_arg_metadata.ScalarArgMetadata.check_datatype (   value )

static

:param str value: the datatype to check for validity.

Reimplemented from psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata.

Reimplemented in psyclone.domain.lfric.kernel.operator_arg_metadata.OperatorArgMetadata, and psyclone.domain.lfric.kernel.field_arg_metadata.FieldArgMetadata.

Definition at line 112 of file scalar_arg_metadata.py.

    def check_datatype(value):
        '''
        :param str value: the datatype to check for validity.
        '''
        const = LFRicConstants()
        ScalarArgMetadata.validate_scalar_value(
            value, const.VALID_SCALAR_DATA_TYPES, "datatype descriptor")
 

Here is the caller graph for this function:

fortran_string()

def psyclone.domain.lfric.kernel.scalar_arg_metadata.ScalarArgMetadata.fortran_string

(

self

)

:returns: the metadata represented by this class as Fortran.
:rtype: str

Reimplemented in psyclone.domain.lfric.kernel.operator_arg_metadata.OperatorArgMetadata, psyclone.domain.lfric.kernel.inter_grid_vector_arg_metadata.InterGridVectorArgMetadata, psyclone.domain.lfric.kernel.inter_grid_arg_metadata.InterGridArgMetadata, psyclone.domain.lfric.kernel.field_vector_arg_metadata.FieldVectorArgMetadata, and psyclone.domain.lfric.kernel.field_arg_metadata.FieldArgMetadata.

Definition at line 104 of file scalar_arg_metadata.py.

    def fortran_string(self):
        '''
        :returns: the metadata represented by this class as Fortran.
        :rtype: str
        '''
        return f"arg_type({self.form}, {self.datatype}, {self.access})"
 

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/domain/lfric/kernel/scalar_arg_metadata.py