Inheritance diagram for psyclone.dynamo0p3.LFRicMeshProperties:

Collaboration diagram for psyclone.dynamo0p3.LFRicMeshProperties:

Public Member Functions
def	__init__ (self, node)

def	kern_args (self, stub=False, var_accesses=None, kern_call_arg_list=None)

def	initialise (self, parent)

Public Member Functions inherited from psyclone.domain.lfric.lfric_collection.LFRicCollection
def	declarations (self, parent)

Detailed Description

Holds all information on the the mesh properties required by either an
invoke or a kernel stub. Note that the creation of a suitable mesh
object is handled in the `DynMeshes` class. This class merely deals with
extracting the necessary properties from that object and providing them to
kernels.

:param node: kernel or invoke for which to manage mesh properties.
:type node: :py:class:`psyclone.domain.lfric.LFRicKern` or \
            :py:class:`psyclone.dynamo0p3.LFRicInvoke`

Definition at line 496 of file dynamo0p3.py.

Member Function Documentation

◆ initialise()

def psyclone.dynamo0p3.LFRicMeshProperties.initialise	(	self,
		parent
	)

Creates the f2pygen nodes for the initialisation of properties of
the mesh.

:param parent: node in the f2pygen tree to which to add statements.
:type parent: :py:class:`psyclone.f2pygen.SubroutineGen`

:raises InternalError: if an unsupported mesh property is encountered.

Reimplemented from psyclone.domain.lfric.lfric_collection.LFRicCollection.

Definition at line 749 of file dynamo0p3.py.

     def initialise(self, parent):
         '''
         Creates the f2pygen nodes for the initialisation of properties of
         the mesh.
  
         :param parent: node in the f2pygen tree to which to add statements.
         :type parent: :py:class:`psyclone.f2pygen.SubroutineGen`
  
         :raises InternalError: if an unsupported mesh property is encountered.
  
         '''
         const = LFRicConstants()
         # Since colouring is applied via transformations, we have to check for
         # it now, rather than when this class was first constructed.
         need_colour_limits = False
         need_colour_halo_limits = False
         for call in self._calls:
             if call.is_coloured() and not call.is_intergrid:
                 loop = call.parent.parent
                 # Record whether or not this coloured loop accesses the halo.
                 if loop.upper_bound_name in const.HALO_ACCESS_LOOP_BOUNDS:
                     need_colour_halo_limits = True
                 else:
                     need_colour_limits = True
  
         if not self._properties and not (need_colour_limits or
                                          need_colour_halo_limits):
             # If no mesh properties are required and there's no colouring
             # (which requires a mesh object to lookup loop bounds) then we
             # need do nothing.
             return
  
         parent.add(CommentGen(parent, ""))
         parent.add(CommentGen(parent, " Initialise mesh properties"))
         parent.add(CommentGen(parent, ""))
  
         mesh = self._symbol_table.find_or_create_tag("mesh").name
  
         for prop in self._properties:
             if prop == MeshProperty.ADJACENT_FACE:
                 adj_face = self._symbol_table.find_or_create_tag(
                     "adjacent_face").name
                 parent.add(AssignGen(parent, pointer=True, lhs=adj_face,
                                      rhs=mesh+"%get_adjacent_face()"))
  
             elif prop == MeshProperty.NCELL_2D_NO_HALOS:
                 name = self._symbol_table.find_or_create_integer_symbol(
                     "ncell_2d_no_halos", tag="ncell_2d_no_halos").name
                 parent.add(AssignGen(parent, lhs=name,
                                      rhs=mesh+"%get_last_edge_cell()"))
  
             elif prop == MeshProperty.NCELL_2D:
                 name = self._symbol_table.find_or_create_integer_symbol(
                     "ncell_2d", tag="ncell_2d").name
                 parent.add(AssignGen(parent, lhs=name,
                                      rhs=mesh+"%get_ncells_2d()"))
             else:
                 raise InternalError(
                     f"Found unsupported mesh property '{str(prop)}' when "
                     f"generating initialisation code. Only members of the "
                     f"MeshProperty Enum are permitted ({list(MeshProperty)})")
  
         if need_colour_halo_limits:
             lhs = self._symbol_table.find_or_create_tag(
                 "last_halo_cell_all_colours").name
             rhs = f"{mesh}%get_last_halo_cell_all_colours()"
             parent.add(AssignGen(parent, lhs=lhs, rhs=rhs))
         if need_colour_limits:
             lhs = self._symbol_table.find_or_create_tag(
                 "last_edge_cell_all_colours").name
             rhs = f"{mesh}%get_last_edge_cell_all_colours()"
             parent.add(AssignGen(parent, lhs=lhs, rhs=rhs))
  
  

References psyclone.domain.lfric.lfric_collection.LFRicCollection._calls, psyclone.parse.algorithm.FileInfo._calls, psyclone.dynamo0p3.LFRicMeshProperties._properties, psyclone.dynamo0p3.DynReferenceElement._properties, psyclone.domain.lfric.lfric_collection.LFRicCollection._symbol_table, psyclone.dynamo0p3.DynMeshes._symbol_table, psyclone.dynamo0p3.HaloDepth._symbol_table, psyclone.psyGen.HaloExchange._symbol_table, psyclone.psyir.backend.sympy_writer.SymPyWriter._symbol_table, and psyclone.psyir.nodes.scoping_node.ScopingNode._symbol_table.

◆ kern_args()

def psyclone.dynamo0p3.LFRicMeshProperties.kern_args	(	self,
		stub = `False`,
		var_accesses = `None`,
		kern_call_arg_list = `None`
	)

Provides the list of kernel arguments associated with the mesh
properties that the kernel requires. Optionally adds variable
access information if var_accesses is given.

:param bool stub: whether or not we are generating code for a \
                  kernel stub.
:param var_accesses: optional VariablesAccessInfo instance to store \
    the information about variable accesses.
:type var_accesses: \
    :py:class:`psyclone.core.VariablesAccessInfo`
:param kern_call_arg_list: an optional KernCallArgList instance \
    used to store PSyIR representation of the arguments.
:type kern_call_arg_list: \
    Optional[:py:class:`psyclone.domain.lfric.KernCallArgList`]

:returns: the kernel arguments associated with the mesh properties.
:rtype: list of str

:raises InternalError: if the class has been constructed for an \
                       invoke rather than a single kernel call.
:raises InternalError: if an unsupported mesh property is encountered.

Definition at line 544 of file dynamo0p3.py.

                   kern_call_arg_list=None):
         # pylint: disable=too-many-locals, too-many-branches
         '''
         Provides the list of kernel arguments associated with the mesh
         properties that the kernel requires. Optionally adds variable
         access information if var_accesses is given.
  
         :param bool stub: whether or not we are generating code for a \
                           kernel stub.
         :param var_accesses: optional VariablesAccessInfo instance to store \
             the information about variable accesses.
         :type var_accesses: \
             :py:class:`psyclone.core.VariablesAccessInfo`
         :param kern_call_arg_list: an optional KernCallArgList instance \
             used to store PSyIR representation of the arguments.
         :type kern_call_arg_list: \
             Optional[:py:class:`psyclone.domain.lfric.KernCallArgList`]
  
         :returns: the kernel arguments associated with the mesh properties.
         :rtype: list of str
  
         :raises InternalError: if the class has been constructed for an \
                                invoke rather than a single kernel call.
         :raises InternalError: if an unsupported mesh property is encountered.
  
         '''
         if not self._kernel:
             raise InternalError(
                 "LFRicMeshProperties.kern_args() can only be called when "
                 "LFRicMeshProperties has been instantiated for a kernel "
                 "rather than an invoke.")
  
         arg_list = []
  
         for prop in self._properties:
             if prop == MeshProperty.ADJACENT_FACE:
                 # Is this kernel already being passed the number of horizontal
                 # faces of the reference element?
                 has_nfaces = (
                     RefElementMetaData.Property.NORMALS_TO_HORIZONTAL_FACES
                     in self._kernel.reference_element.properties or
                     RefElementMetaData.Property.
                     OUTWARD_NORMALS_TO_HORIZONTAL_FACES
                     in self._kernel.reference_element.properties)
                 if not has_nfaces:
                     if kern_call_arg_list:
                         sym = kern_call_arg_list.\
                             append_integer_reference("nfaces_re_h")
                         name = sym.name
                     else:
                         name = self._symbol_table.\
                             find_or_create_integer_symbol(
                                 "nfaces_re_h", tag="nfaces_re_h").name
                     arg_list.append(name)
                     if var_accesses is not None:
                         var_accesses.add_access(Signature(name),
                                                 AccessType.READ, self._kernel)
  
                 adj_face = "adjacent_face"
                 if not stub and kern_call_arg_list:
                     # Use the functionality in kern_call_arg_list to properly
                     # declare the symbol and to create a PSyIR reference for it
                     _, cell_ref = \
                         kern_call_arg_list.cell_ref_name(var_accesses)
                     adj_face_sym = kern_call_arg_list. \
                         append_array_reference(adj_face,
                                                [":", cell_ref],
                                                ScalarType.Intrinsic.INTEGER)
                     # Update the name in case there was a clash
                     adj_face = adj_face_sym.name
                     if var_accesses:
                         var_accesses.add_access(Signature(adj_face),
                                                 AccessType.READ, self._kernel,
                                                 [":", cell_ref])
  
                 if not stub:
                     adj_face = self._symbol_table.find_or_create_tag(
                         "adjacent_face").name
                     cell_name = "cell"
                     if self._kernel.is_coloured():
                         colour_name = "colour"
                         cmap_name = self._symbol_table.find_or_create_tag(
                             "cmap", root_name="cmap").name
                         adj_face += (f"(:,{cmap_name}({colour_name},"
                                      f"{cell_name}))")
                     else:
                         adj_face += f"(:,{cell_name})"
                 arg_list.append(adj_face)
  
                 if var_accesses and not kern_call_arg_list:
                     # TODO #1320 Replace [1]
                     # The [1] just indicates that this variable is accessed
                     # as a rank 1 array. #1320 will improve this.
                     var_accesses.add_access(Signature(adj_face),
                                             AccessType.READ, self._kernel,
                                             [1])
             else:
                 raise InternalError(
                     f"kern_args: found unsupported mesh property '{prop}' "
                     f"when generating arguments for kernel "
                     f"'{self._kernel.name}'. Only members of the MeshProperty "
                     f"Enum are permitted ({list(MeshProperty)}).")
  
         return arg_list
  

References psyclone.domain.lfric.lfric_collection.LFRicCollection._invoke, psyclone.nemo.NemoInvokeSchedule._invoke, psyclone.psyGen.InvokeSchedule._invoke, psyclone.domain.lfric.lfric_collection.LFRicCollection._kernel, psyclone.dynamo0p3.LFRicMeshProperties._properties, psyclone.dynamo0p3.DynReferenceElement._properties, psyclone.domain.lfric.lfric_collection.LFRicCollection._symbol_table, psyclone.dynamo0p3.DynMeshes._symbol_table, psyclone.dynamo0p3.HaloDepth._symbol_table, psyclone.psyGen.HaloExchange._symbol_table, psyclone.psyir.backend.sympy_writer.SymPyWriter._symbol_table, and psyclone.psyir.nodes.scoping_node.ScopingNode._symbol_table.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ initialise()

◆ kern_args()