Inheritance diagram for psyclone.domain.gocean.kernel.psyir.GOceanContainer:

Collaboration diagram for psyclone.domain.gocean.kernel.psyir.GOceanContainer:

Public Member Functions
def	__init__ (self, name, metadata, **kwargs)

def	create (cls, name, metadata, symbol_table, children)

def	metadata (self)

def	lower_to_language_level (self)

Detailed Description

A GOcean-specific Container. This specialises the generic Container node
and adds in any domain-specific information.

:param str name: the name of the container.
:param metadata: the metadata object.
:type metadata: :py:class:`psyclone.domain.gocean.kernel.psyir.\
    GOceanKernelMetadata`
:param parent: optional parent node of this Container in the PSyIR.
:type parent: :py:class:`psyclone.psyir.nodes.Node`
:param symbol_table: initialise the node with a given symbol table.
:type symbol_table: \
    Optional[:py:class:`psyclone.psyir.symbols.SymbolTable`]

Definition at line 57 of file psyir.py.

Member Function Documentation

◆ create()

def psyclone.domain.gocean.kernel.psyir.GOceanContainer.create	(	cls,
		name,
		metadata,
		symbol_table,
		children
	)

Create a GOceanContainer instance given a name, metadata, a symbol
table and a list of child nodes. A GOcean-specific kernel is
created with the metadata describing the kernel interface for
a single kernel routine within the container.

:param str name: the name of the Container.
:param symbol_table: the symbol table associated with this \
    Container.
:type symbol_table: :py:class:`psyclone.psyir.symbols.SymbolTable`
:param metadata: the metadata object.
:type metadata: :py:class:`psyclone.domain.gocean.kernel.psyir.\
    GOceanKernelMetadata`
:param children: a list of PSyIR nodes contained in the \
    Container. These must be Containers or Routines.
:type children: List[:py:class:`psyclone.psyir.nodes.Container` \
    | :py:class:`psyclone.psyir.nodes.Routine`]

:returns: an instance of `cls`.
:rtype: :py:class:`psyclone.psyir.nodes.Container` or subclass
    thereof

Definition at line 78 of file psyir.py.

     def create(cls, name, metadata, symbol_table, children):
         '''Create a GOceanContainer instance given a name, metadata, a symbol
         table and a list of child nodes. A GOcean-specific kernel is
         created with the metadata describing the kernel interface for
         a single kernel routine within the container.
  
         :param str name: the name of the Container.
         :param symbol_table: the symbol table associated with this \
             Container.
         :type symbol_table: :py:class:`psyclone.psyir.symbols.SymbolTable`
         :param metadata: the metadata object.
         :type metadata: :py:class:`psyclone.domain.gocean.kernel.psyir.\
             GOceanKernelMetadata`
         :param children: a list of PSyIR nodes contained in the \
             Container. These must be Containers or Routines.
         :type children: List[:py:class:`psyclone.psyir.nodes.Container` \
             | :py:class:`psyclone.psyir.nodes.Routine`]
  
         :returns: an instance of `cls`.
         :rtype: :py:class:`psyclone.psyir.nodes.Container` or subclass
             thereof
  
         '''
         return cls(name, metadata, children=children,
                    symbol_table=symbol_table.detach())
  

Here is the caller graph for this function:

◆ lower_to_language_level()

def psyclone.domain.gocean.kernel.psyir.GOceanContainer.lower_to_language_level ( self )

Lower this GOcean-specific container to language level psyir.

:returns: the lowered version of this node.
:rtype: :py:class:`psyclone.psyir.node.Node`

Definition at line 113 of file psyir.py.

     def lower_to_language_level(self):
         '''Lower this GOcean-specific container to language level psyir.
  
         :returns: the lowered version of this node.
         :rtype: :py:class:`psyclone.psyir.node.Node`
  
         '''
         # Create metadata symbol and add it to the container symbol
         # table.
         data_symbol = self.metadata.lower_to_psyir()
         self.symbol_table.add(data_symbol)
  
         # Replace this gocean container with a generic container
         children = self.pop_all_children()
         generic_container = Container.create(
             self.name, self.symbol_table.detach(), children)
         self.replace_with(generic_container)
         return generic_container
  
  

Here is the caller graph for this function:

◆ metadata()

def psyclone.domain.gocean.kernel.psyir.GOceanContainer.metadata ( self )

:returns the GOcean metadata object.
:rtype: :py:class:`psyclone.domain.gocean.kernel.psyir.\
    GOceanKernelMetadata`

Definition at line 105 of file psyir.py.

     def metadata(self):
         '''
         :returns the GOcean metadata object.
         :rtype: :py:class:`psyclone.domain.gocean.kernel.psyir.\
             GOceanKernelMetadata`
         '''
         return self._metadata
  

References psyclone.domain.gocean.kernel.psyir.GOceanContainer._metadata, psyclone.domain.lfric.kernel.psyir.LFRicKernelContainer._metadata, and psyclone.domain.lfric.metadata_to_arguments_rules.MetadataToArgumentsRules._metadata.

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/gocean/kernel/psyir.py

Public Member Functions

Detailed Description

Member Function Documentation

◆ create()

◆ lower_to_language_level()

◆ metadata()