Public Member Functions
def	__init__ (self, fine_arg, coarse_arg)

def	set_colour_info (self, colour_map, ncolours, last_cell)

def	colourmap_symbol (self)

def	ncolours_var_symbol (self)

def	last_cell_var_symbol (self)

Public Attributes
	coarse

	fine

	mmap

	ncell_fine

	ncellpercellx

	ncellpercelly

	cell_map

Detailed Description

Holds information on quantities required by an inter-grid kernel.

:param fine_arg: Kernel argument on the fine mesh.
:type fine_arg: :py:class:`psyclone.dynamo0p3.DynKernelArgument`
:param coarse_arg: Kernel argument on the coarse mesh.
:type coarse_arg: :py:class:`psyclone.dynamo0p3.DynKernelArgument`

Definition at line 2538 of file dynamo0p3.py.

Member Function Documentation

◆ colourmap_symbol()

def psyclone.dynamo0p3.DynInterGrid.colourmap_symbol ( self )

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

Definition at line 2606 of file dynamo0p3.py.

     def colourmap_symbol(self):
         ''':returns: the colour map symbol.
         :rtype: :py:class:`psyclone.psyir.symbols.Symbol`
         '''
         return self._colourmap_symbol
  

References psyclone.dynamo0p3.DynInterGrid._colourmap_symbol.

◆ last_cell_var_symbol()

def psyclone.dynamo0p3.DynInterGrid.last_cell_var_symbol ( self )

:returns: the last halo/edge cell variable.
:rtype: :py:class:`psyclone.psyir.symbols.Symbol`

Definition at line 2620 of file dynamo0p3.py.

     def last_cell_var_symbol(self):
         ''':returns: the last halo/edge cell variable.
         :rtype: :py:class:`psyclone.psyir.symbols.Symbol`
         '''
         return self._last_cell_var_symbol
  
  

References psyclone.dynamo0p3.DynInterGrid._last_cell_var_symbol.

◆ ncolours_var_symbol()

def psyclone.dynamo0p3.DynInterGrid.ncolours_var_symbol ( self )

:returns: the symbol for storing the number of colours.
:rtype: :py:class:`psyclone.psyir.symbols.Symbol`

Definition at line 2613 of file dynamo0p3.py.

     def ncolours_var_symbol(self):
         ''':returns: the symbol for storing the number of colours.
         :rtype: :py:class:`psyclone.psyir.symbols.Symbol`
         '''
         return self._ncolours_var_symbol
  

References psyclone.dynamo0p3.DynInterGrid._ncolours_var_symbol.

◆ set_colour_info()

def psyclone.dynamo0p3.DynInterGrid.set_colour_info	(	self,
		colour_map,
		ncolours,
		last_cell
	)

Sets the colour_map, number of colours, and
last cell of a particular colour.

:param colour_map: the colour map symbol.
:type: colour_map:py:class:`psyclone.psyir.symbols.Symbol`
:param ncolours: the number of colours.
:type: ncolours: :py:class:`psyclone.psyir.symbols.Symbol`
:param last_cell: the last halo cell of a particular colour.
:type last_cell: :py:class:`psyclone.psyir.symbols.Symbol`

Definition at line 2589 of file dynamo0p3.py.

     def set_colour_info(self, colour_map, ncolours, last_cell):
         '''Sets the colour_map, number of colours, and
         last cell of a particular colour.
  
         :param colour_map: the colour map symbol.
         :type: colour_map:py:class:`psyclone.psyir.symbols.Symbol`
         :param ncolours: the number of colours.
         :type: ncolours: :py:class:`psyclone.psyir.symbols.Symbol`
         :param last_cell: the last halo cell of a particular colour.
         :type last_cell: :py:class:`psyclone.psyir.symbols.Symbol`
  
         '''
         self._colourmap_symbol = colour_map
         self._ncolours_var_symbol = ncolours
         self._last_cell_var_symbol = last_cell
  

References psyclone.dynamo0p3.DynInterGrid._colourmap_symbol, psyclone.dynamo0p3.DynInterGrid._last_cell_var_symbol, and psyclone.dynamo0p3.DynInterGrid._ncolours_var_symbol.

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

/home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/dynamo0p3.py