psyclone.domain.lfric.lfric_builtins.LFRicBuiltInCallFactory Class Reference

Public Member Functions
def	__str__ (self)

Static Public Member Functions
def	create (call, parent=None)

Detailed Description

Creates the necessary framework for a call to an LFRic built-in,
This consists of the operation itself and the loop over unique
DoFs.

Definition at line 89 of file lfric_builtins.py.

Member Function Documentation

create()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltInCallFactory.create (   call,   parent = None  )

static

Create the objects needed for a call to the built-in described in
the call (BuiltInCall) object.

:param call: details of the call to this built-in in the \
             Algorithm layer.
:type call: :py:class:`psyclone.parse.algorithm.BuiltInCall`
:param parent: the schedule instance to which the built-in call \
               belongs.
:type parent: :py:class:`psyclone.domain.lfric.LFRicInvokeSchedule`

:raises ParseError: if the name of the function being called is \
                    not a recognised built-in.
:raises InternalError: if the built-in does not iterate over DoFs.

Definition at line 100 of file lfric_builtins.py.

    def create(call, parent=None):
        '''
        Create the objects needed for a call to the built-in described in
        the call (BuiltInCall) object.
 
        :param call: details of the call to this built-in in the \
                     Algorithm layer.
        :type call: :py:class:`psyclone.parse.algorithm.BuiltInCall`
        :param parent: the schedule instance to which the built-in call \
                       belongs.
        :type parent: :py:class:`psyclone.domain.lfric.LFRicInvokeSchedule`
 
        :raises ParseError: if the name of the function being called is \
                            not a recognised built-in.
        :raises InternalError: if the built-in does not iterate over DoFs.
 
        '''
        if call.func_name not in BUILTIN_MAP:
            raise ParseError(
                f"Unrecognised built-in call in LFRic API: found "
                f"'{call.func_name}' but expected one of "
                f"{list(BUILTIN_MAP_CAPITALISED.keys())}.")
 
        # Use our dictionary to get the correct Python object for
        # this built-in.
        builtin = BUILTIN_MAP[call.func_name]()
 
        # Create the loop over the appropriate entity.
        # Avoid circular import
        # pylint: disable=import-outside-toplevel
        from psyclone.domain.lfric import LFRicLoop
 
        if call.ktype.iterates_over == "dof":
            loop_type = "dof"
        else:
            raise InternalError(
                f"An LFRic built-in must iterate over DoFs but kernel "
                f"'{call.func_name}' iterates over "
                f"'{call.ktype.iterates_over}'")
        dofloop = LFRicLoop(parent=parent, loop_type=loop_type)
 
        # Use the call object (created by the parser) to set-up the state
        # of the infrastructure kernel
        builtin.load(call, parent=dofloop.loop_body)
 
        # Set-up its state
        dofloop.load(builtin)
 
        # As it is the innermost loop it has the kernel as a loop_body
        # child.
        dofloop.loop_body.addchild(builtin)
 
        # Return the outermost loop
        return dofloop
 
 

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/lfric/lfric_builtins.py