psyclone.dynamo0p3.DynReferenceElement Class Reference

Inheritance diagram for psyclone.dynamo0p3.DynReferenceElement:

Collaboration diagram for psyclone.dynamo0p3.DynReferenceElement:

Public Member Functions
def	__init__ (self, node)
def	kern_args (self)
def	kern_args_symbols (self)
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 properties of the Reference Element
required by an Invoke or a Kernel stub.

:param node: Kernel or Invoke for which to manage Reference-Element \
             properties.
:type node: :py:class:`psyclone.domain.lfric.LFRicKern` or \
            :py:class:`psyclone.dynamo0p3.LFRicInvoke`

:raises InternalError: if an unsupported reference-element property \
                       is encountered.

Definition at line 823 of file dynamo0p3.py.

Member Function Documentation

initialise()

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

Creates the f2pygen nodes representing the necessary initialisation
code for properties of the reference element.

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

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

Definition at line 1100 of file dynamo0p3.py.

    def initialise(self, parent):
        '''
        Creates the f2pygen nodes representing the necessary initialisation
        code for properties of the reference element.
 
        :param parent: node in the f2pygen tree to which to add statements.
        :type parent: :py:class:`psyclone.f2pygen.SubroutineGen`
 
        '''
        if not (self._properties or self._nfaces_h_required):
            return
 
        parent.add(CommentGen(parent, ""))
        parent.add(
            CommentGen(parent,
                       " Get the reference element and query its properties"))
        parent.add(CommentGen(parent, ""))
 
        mesh_obj_name = self._symbol_table.find_or_create_tag("mesh").name
        parent.add(AssignGen(parent, pointer=True, lhs=self._ref_elem_name,
                             rhs=mesh_obj_name+"%get_reference_element()"))
 
        if self._nfaces_h_symbol:
            parent.add(
                AssignGen(parent, lhs=self._nfaces_h_symbol.name,
                          rhs=self._ref_elem_name +
                          "%get_number_horizontal_faces()"))
        if self._nfaces_v_symbol:
            parent.add(
                AssignGen(
                    parent, lhs=self._nfaces_v_symbol.name,
                    rhs=self._ref_elem_name + "%get_number_vertical_faces()"))
 
        if self._nfaces_symbol:
            parent.add(
                AssignGen(
                    parent, lhs=self._nfaces_symbol.name,
                    rhs=self._ref_elem_name + "%get_number_faces()"))
 
        if self._horiz_face_normals_symbol:
            parent.add(
                CallGen(parent,
                        name=f"{self._ref_elem_name}%get_normals_to_"
                             f"horizontal_faces("
                             f"{self._horiz_face_normals_symbol.name})"))
 
        if self._horiz_face_out_normals_symbol:
            parent.add(
                CallGen(
                    parent,
                    name=f"{self._ref_elem_name}%get_outward_normals_to_"
                         f"horizontal_faces("
                         f"{self._horiz_face_out_normals_symbol.name})"))
 
        if self._vert_face_normals_symbol:
            parent.add(
                CallGen(parent,
                        name=f"{self._ref_elem_name}%get_normals_to_vertical_"
                             f"faces({self._vert_face_normals_symbol.name})"))
 
        if self._vert_face_out_normals_symbol:
            parent.add(
                CallGen(
                    parent,
                    name=f"{self._ref_elem_name}%get_outward_normals_to_"
                         f"vertical_faces"
                         f"({self._vert_face_out_normals_symbol.name})"))
 
        if self._face_normals_symbol:
            parent.add(
                CallGen(parent,
                        name=f"{self._ref_elem_name}%get_normals_to_faces"
                             f"({self._face_normals_symbol.name})"))
 
        if self._face_out_normals_symbol:
            parent.add(
                CallGen(
                    parent,
                    name=f"{self._ref_elem_name}%get_outward_normals_to_"
                    f"faces({self._face_out_normals_symbol.name})"))
 
 

References psyclone.dynamo0p3.DynReferenceElement._face_normals_symbol, psyclone.dynamo0p3.DynReferenceElement._face_out_normals_symbol, psyclone.dynamo0p3.DynReferenceElement._horiz_face_normals_symbol, psyclone.dynamo0p3.DynReferenceElement._horiz_face_out_normals_symbol, psyclone.dynamo0p3.DynReferenceElement._nfaces_h_required, psyclone.dynamo0p3.DynReferenceElement._nfaces_h_symbol, psyclone.dynamo0p3.DynReferenceElement._nfaces_symbol, psyclone.dynamo0p3.DynReferenceElement._nfaces_v_symbol, psyclone.dynamo0p3.LFRicMeshProperties._properties, psyclone.dynamo0p3.DynReferenceElement._properties, psyclone.dynamo0p3.DynReferenceElement._ref_elem_name, 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, psyclone.psyir.nodes.scoping_node.ScopingNode._symbol_table, psyclone.dynamo0p3.DynReferenceElement._vert_face_normals_symbol, and psyclone.dynamo0p3.DynReferenceElement._vert_face_out_normals_symbol.

kern_args()

def psyclone.dynamo0p3.DynReferenceElement.kern_args

(

self

)

:returns: the argument list for kernel call/stub arguments.
:rtype: List[str]

Definition at line 990 of file dynamo0p3.py.

    def kern_args(self):
        '''
        :returns: the argument list for kernel call/stub arguments.
        :rtype: List[str]
 
        '''
        argdict = self._arg_properties
        # Remove duplicate "nfaces" by using OrderedDict
        nfaces = list(OrderedDict.fromkeys(argdict.values()))
        kern_args = nfaces + list(argdict.keys())
        return [sym.name for sym in kern_args]
 

References psyclone.dynamo0p3.DynReferenceElement._arg_properties.

kern_args_symbols()

def psyclone.dynamo0p3.DynReferenceElement.kern_args_symbols

(

self

)

:returns: the argument symbol list for kernel call/stub arguments.
:rtype: List[:py:class:`psyclone.psyir.symbols.Symbol`]

Definition at line 1002 of file dynamo0p3.py.

    def kern_args_symbols(self):
        '''
        :returns: the argument symbol list for kernel call/stub arguments.
        :rtype: List[:py:class:`psyclone.psyir.symbols.Symbol`]
 
        '''
        argdict = self._arg_properties
        # Remove duplicate "nfaces" by using OrderedDict
        nfaces = list(OrderedDict.fromkeys(argdict.values()))
        return nfaces + list(argdict.keys())
 

References psyclone.dynamo0p3.DynReferenceElement._arg_properties, psyclone.domain.lfric.lfric_collection.LFRicCollection._invoke, psyclone.nemo.NemoInvokeSchedule._invoke, psyclone.psyGen.InvokeSchedule._invoke, psyclone.dynamo0p3.DynReferenceElement._nfaces_h_required, psyclone.dynamo0p3.DynReferenceElement._nfaces_h_symbol, psyclone.dynamo0p3.LFRicMeshProperties._properties, psyclone.dynamo0p3.DynReferenceElement._properties, psyclone.dynamo0p3.DynReferenceElement._ref_elem_name, 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