Inheritance diagram for psyclone.domain.lfric.lfric_symbol_table.LFRicSymbolTable:

Collaboration diagram for psyclone.domain.lfric.lfric_symbol_table.LFRicSymbolTable:

Public Member Functions
def	__init__ (self, node=None, default_visibility=Symbol.Visibility.PUBLIC)

def	find_or_create_integer_symbol (self, name, tag=None)

def	find_or_create_array (self, array_name, num_dimensions, intrinsic_type, tag=None)

def	add_lfric_precision_symbol (self, name)

Detailed Description

Sub-classes SymbolTable to provide a LFRic-specific implementation.

:param node: reference to the Schedule or Container to which this \
    symbol table belongs.
:type node: :py:class:`psyclone.psyir.nodes.Schedule`, \
    :py:class:`psyclone.psyir.nodes.Container` or NoneType
:param default_visibility: optional default visibility value for this \
    symbol table, if not provided it defaults to PUBLIC visibility.
:type default_visibillity: \
    :py:class:`psyclone.psyir.symbols.Symbol.Visibility`

Definition at line 54 of file lfric_symbol_table.py.

Member Function Documentation

◆ add_lfric_precision_symbol()

def psyclone.domain.lfric.lfric_symbol_table.LFRicSymbolTable.add_lfric_precision_symbol	(	self,
		name
	)

If the named LFRic precision symbol is not already in the table then
add it. Also ensure that the Container symbol from which it is
imported is in the table.

:param str name: name of the LFRic precision symbol to add to table.

:returns: the specified LFRic precision symbol.
:rtype: :py:class:`psyclone.psyir.symbols.DataSymbol`

:raises ValueError: if the supplied name is not a recognised LFRic \
    precision variable.
:raises ValueError: if a symbol with the same name is already in the \
    table but is not imported from the correct container.

Definition at line 210 of file lfric_symbol_table.py.

     def add_lfric_precision_symbol(self, name):
         '''
         If the named LFRic precision symbol is not already in the table then
         add it. Also ensure that the Container symbol from which it is
         imported is in the table.
  
         :param str name: name of the LFRic precision symbol to add to table.
  
         :returns: the specified LFRic precision symbol.
         :rtype: :py:class:`psyclone.psyir.symbols.DataSymbol`
  
         :raises ValueError: if the supplied name is not a recognised LFRic \
             precision variable.
         :raises ValueError: if a symbol with the same name is already in the \
             table but is not imported from the correct container.
  
         '''
         api_config = Config.get().api_conf("dynamo0.3")
         if name not in api_config.precision_map.keys():
             raise ValueError(f"'{name}' is not a recognised LFRic precision.")
         sym = LFRicSymbolTable._precision_map[name]
  
         if name in self:
             # Sanity check that the existing symbol is the right one.
             existing_sym = self.lookup(name)
             if (not isinstance(existing_sym.interface, ImportInterface) or
                     existing_sym.interface.container_symbol.name !=
                     self._constants_mod.name):
                 raise ValueError(
                     f"Precision symbol '{name}' already exists in the "
                     f"supplied symbol table but is not imported from the "
                     f"LFRic constants module ({self._constants_mod.name}).")
             return existing_sym
  
         # pylint: disable=undefined-variable
         if self._constants_mod.name not in self:
             self.add(self._constants_mod)
         self.add(sym)
         return sym

References psyclone.domain.lfric.lfric_symbol_table.LFRicSymbolTable._constants_mod, psyclone.f2pygen.IfThenGen.add(), psyclone.f2pygen.ProgUnitGen.add(), psyclone.f2pygen.DoGen.add(), psyclone.psyir.symbols.datatypes.StructureType.add(), psyclone.f2pygen.BaseGen.add(), psyclone.psyir.symbols.symbol_table.SymbolTable.add(), psyclone.psyir.symbols.datatypes.StructureType.lookup(), and psyclone.psyir.symbols.symbol_table.SymbolTable.lookup().

Here is the call graph for this function:

◆ find_or_create_array()

def psyclone.domain.lfric.lfric_symbol_table.LFRicSymbolTable.find_or_create_array	(	self,
		array_name,
		num_dimensions,
		intrinsic_type,
		tag = `None`
	)

This function returns a symbol for an ArrayReference. If the
symbol does not exist, it is created. If a new array symbol is
created, it gets the DEFERRED attribute, which in Fortran means
it will be declared as an allocatable array.

:param str array_name: the name and tag of the array.
:param int num_dimensions: the number of dimensions of this array.
:param intrinsic_type: the intrinsic type of the array.
:type intrinsic_type: \
    :py:class:`psyclone.psyir.symbols.datatypes.ScalarType.Intrinsic`
:param tag: optional tag to be used in searching and defining.
:type tag: Optional[str]

:returns: the requested symbol
:rtype: :py:class:`psyclone.psyir.symbols.Symbol`

:raises TypeError: if the symbol exists, but is not a DataSymbol, \
    or not an Array, or has different number of dimensions.

Definition at line 138 of file lfric_symbol_table.py.

                              tag=None):
         '''This function returns a symbol for an ArrayReference. If the
         symbol does not exist, it is created. If a new array symbol is
         created, it gets the DEFERRED attribute, which in Fortran means
         it will be declared as an allocatable array.
  
         :param str array_name: the name and tag of the array.
         :param int num_dimensions: the number of dimensions of this array.
         :param intrinsic_type: the intrinsic type of the array.
         :type intrinsic_type: \
             :py:class:`psyclone.psyir.symbols.datatypes.ScalarType.Intrinsic`
         :param tag: optional tag to be used in searching and defining.
         :type tag: Optional[str]
  
         :returns: the requested symbol
         :rtype: :py:class:`psyclone.psyir.symbols.Symbol`
  
         :raises TypeError: if the symbol exists, but is not a DataSymbol, \
             or not an Array, or has different number of dimensions.
  
         '''
         if intrinsic_type == ScalarType.Intrinsic.REAL:
             datatype = LFRicTypes("LFRicRealScalarDataType")()
         elif intrinsic_type == ScalarType.Intrinsic.INTEGER:
             datatype = LFRicTypes("LFRicIntegerScalarDataType")()
         elif intrinsic_type == ScalarType.Intrinsic.BOOLEAN:
             datatype = LFRicTypes("LFRicLogicalScalarDataType")()
         else:
             raise TypeError(f"Unsupported data type "
                             f"'{intrinsic_type}' in "
                             f"find_or_create_array")
  
         try:
             if tag:
                 sym = self.lookup_with_tag(tag)
             else:
                 sym = self.lookup(array_name)
         except KeyError:
             # pylint: disable=raise-missing-from
             # Create a DataSymbol for this kernel argument.
             array_type = ArrayType(datatype,
                                    [ArrayType.Extent.DEFERRED]*num_dimensions)
  
             sym = self.new_symbol(array_name, tag=tag,
                                   symbol_type=DataSymbol,
                                   datatype=array_type)
             return sym
  
         # Symbol already exists, check consistency:
         if not isinstance(sym, DataSymbol):
             raise TypeError(f"Symbol '{sym.name}' already exists, but is "
                             f"not a DataSymbol, but '{type(sym)}'.")
  
         if not isinstance(sym.datatype, ArrayType):
             raise TypeError(f"Symbol '{sym.name}' already exists, but is "
                             f"not an ArraySymbol, but "
                             f"'{type(sym.datatype)}'.")
  
         if sym.datatype.datatype != datatype:
             raise TypeError(f"Symbol '{sym.name}' already exists, but is "
                             f"not of type '{intrinsic_type}', but "
                             f"'{type(sym.datatype.datatype)}'.")
  
         if len(sym.shape) != num_dimensions:
             raise TypeError(f"Array '{sym.name}' already exists, but has "
                             f"{len(sym.shape)} dimensions, not "
                             f"{num_dimensions}.")
  
         return sym
  

References psyclone.psyir.symbols.datatypes.StructureType.lookup(), psyclone.psyir.symbols.symbol_table.SymbolTable.lookup(), psyclone.psyir.symbols.symbol_table.SymbolTable.lookup_with_tag(), and psyclone.psyir.symbols.symbol_table.SymbolTable.new_symbol().

Here is the call graph for this function:

◆ find_or_create_integer_symbol()

def psyclone.domain.lfric.lfric_symbol_table.LFRicSymbolTable.find_or_create_integer_symbol	(	self,
		name,
		tag = `None`
	)

This function returns a symbol for an integer reference. If a
tag is specified, it will be used to search for an existing symbol,
otherwise the name will be used. If the symbol should not already
exist in the symbol table, it will be returned, otherwise a new
symbol will be created.

:param str name: name of the integer variable to declare.
:param tag: optional tag of the integer variable to declare.
:type tag: Optional[str]

:returns: the symbol for the variable.
:rtype: :py:class:`psyclone.psyir.symbols.Symbol`

:raises TypeError: TypeError if the symbol exists but is not \
    a DataSymbol.
:raises TypeError: TypeError if the symbol exists and is a \
    DataSymbol, but not an Integer.

Definition at line 90 of file lfric_symbol_table.py.

     def find_or_create_integer_symbol(self, name, tag=None):
         '''This function returns a symbol for an integer reference. If a
         tag is specified, it will be used to search for an existing symbol,
         otherwise the name will be used. If the symbol should not already
         exist in the symbol table, it will be returned, otherwise a new
         symbol will be created.
  
         :param str name: name of the integer variable to declare.
         :param tag: optional tag of the integer variable to declare.
         :type tag: Optional[str]
  
         :returns: the symbol for the variable.
         :rtype: :py:class:`psyclone.psyir.symbols.Symbol`
  
         :raises TypeError: TypeError if the symbol exists but is not \
             a DataSymbol.
         :raises TypeError: TypeError if the symbol exists and is a \
             DataSymbol, but not an Integer.
  
         '''
         if tag:
             try:
                 sym = self.lookup_with_tag(tag)
             except KeyError:
                 sym = None
         else:
             try:
                 sym = self.lookup(name)
             except KeyError:
                 sym = None
  
         datatype = LFRicTypes("LFRicIntegerScalarDataType")()
         if sym is None:
             # Create a DataSymbol for this kernel argument.
             sym = self.new_symbol(name, tag=tag,
                                   symbol_type=DataSymbol,
                                   datatype=datatype)
         else:
             # The symbol already exists, check that is the right type:
             if not isinstance(sym, DataSymbol):
                 raise TypeError(f"Symbol '{sym.name}' already exists, but is "
                                 f"not a DataSymbol, but '{type(sym)}'.")
             if sym.datatype != datatype:
                 raise TypeError(f"Symbol '{sym.name}' already exists, but is "
                                 f"not an integer, but '{sym.datatype}'.")
         return sym
  

References psyclone.psyir.symbols.datatypes.StructureType.lookup(), psyclone.psyir.symbols.symbol_table.SymbolTable.lookup(), psyclone.psyir.symbols.symbol_table.SymbolTable.lookup_with_tag(), and psyclone.psyir.symbols.symbol_table.SymbolTable.new_symbol().

Here is the call 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/lfric_symbol_table.py

Public Member Functions

Detailed Description

Member Function Documentation

◆ add_lfric_precision_symbol()

◆ find_or_create_array()

◆ find_or_create_integer_symbol()