# -----------------------------------------------------------------------------
# BSD 3-Clause License
#
# Copyright (c) 2017-2024, Science and Technology Facilities Council.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
# -----------------------------------------------------------------------------
# Authors R. W. Ford, A. R. Porter, S. Siso and N. Nobre, STFC Daresbury Lab
# J. Henrichs, Bureau of Meteorology
# Modified I. Kavcic, Met Office
'''This module contains the GOcean-specific loop-fusion transformation.
'''
from psyclone.psyir.transformations import LoopFuseTrans, TransformationError
import psyclone.gocean1p0
[docs]class GOceanLoopFuseTrans(LoopFuseTrans):
''' GOcean API specialisation of the :py:class:`base class <LoopFuseTrans>`
in order to fuse two GOcean loops after performing validity checks (e.g.
that the loops are over the same grid-point type). For example:
>>> from psyclone.parse.algorithm import parse
>>> from psyclone.psyGen import PSyFactory
>>> ast, invokeInfo = parse("shallow_alg.f90")
>>> psy = PSyFactory("gocean1.0").create(invokeInfo)
>>> schedule = psy.invokes.get('invoke_0').schedule
>>> print(schedule.view())
>>>
>>> from psyclone.transformations import GOceanLoopFuseTrans
>>> ftrans = GOceanLoopFuseTrans()
>>> ftrans.apply(schedule[0], schedule[1])
>>> print(schedule.view())
'''
def __str__(self):
return ("Fuse two adjacent loops together with GOcean-specific "
"validity checks")
[docs] def validate(self, node1, node2, options=None):
'''Checks if it is valid to apply the GOceanLoopFuseTrans
transform. It ensures that the fused loops are over
the same grid-point types, before calling the normal
LoopFuseTrans validation function.
:param node1: the first Node representing a GOLoop.
:type node1: :py:class:`psyclone.gocean1p0.GOLoop`
:param node2: the second Node representing a GOLoop.
:type node2: :py:class:`psyclone.gocean1p0.GOLoop`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]
:raises TransformationError: if the supplied loops are over \
different grid-point types.
:raises TransformationError: if invalid parameters are passed in.
'''
if not (isinstance(node1, psyclone.gocean1p0.GOLoop) and
isinstance(node2, psyclone.gocean1p0.GOLoop)):
raise TransformationError(f"Error in {self.name} transformation. "
f"Both nodes must be of the same "
f"GOLoop class.")
super(GOceanLoopFuseTrans, self).validate(node1, node2,
options=options)
if node1.field_space != node2.field_space:
raise TransformationError(
f"Error in {self.name} transformation. Cannot "
f"fuse loops that are over different grid-point types: "
f"{node1.field_space} and {node2.field_space}")
# For automatic documentation generation
__all__ = ["GOceanLoopFuseTrans"]