Add SIR for unstructured with copy example (#6)

.gitpod.yml

@@ -4,8 +4,7 @@ tasks:
           ln -s /workspace/.caches/pre-commit  ~/.cache/pre-commit
           alias pre-commit="PIP_USER=no pre-commit"
           cd /workspace/eve
-      init: |
           ./scripts/init_env.sh -i
-          pre-commit install
-      command: |
+      init: |
+          pre-commit install --install-hooks
           gp preview file:///workspace/eve/docs/_build/html/index.html

examples/sir_unstructured_copy.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+# Eve toolchain
+
+from devtools import debug  # noqa: F401
+
+import eve  # noqa: F401
+from gt_toolchain.unstructured import common, sir
+
+
+field_acc_a = sir.FieldAccessExpr(
+    name="field_a", vertical_offset=0, horizontal_offset=sir.ZeroOffset()
+)
+field_acc_b = sir.FieldAccessExpr(
+    name="field_b", vertical_offset=0, horizontal_offset=sir.ZeroOffset()
+)
+
+assign_expr = sir.AssignmentExpr(left=field_acc_a, op="=", right=field_acc_b)
+assign_expr_stmt = sir.ExprStmt(expr=assign_expr)
+ast = sir.AST(root=sir.BlockStmt(statements=[assign_expr_stmt]))
+
+vert_decl_stmt = sir.VerticalRegionDeclStmt(
+    vertical_region=sir.VerticalRegion(
+        ast=ast, interval=sir.Interval(), loop_order=common.LoopOrder.FORWARD
+    )
+)
+ctrl_flow_ast = sir.AST(root=sir.BlockStmt(statements=[vert_decl_stmt]))
+
+field_a = sir.Field(
+    name="field_a",
+    is_temporary=False,
+    field_dimensions=sir.FieldDimensions(
+        horizontal_dimension=sir.UnstructuredDimension(dense_location_type=sir.LocationType.Cell)
+    ),
+)
+field_b = sir.Field(
+    name="field_b",
+    is_temporary=False,
+    field_dimensions=sir.FieldDimensions(
+        horizontal_dimension=sir.UnstructuredDimension(dense_location_type=sir.LocationType.Cell)
+    ),
+)
+
+stencil = sir.Stencil(name="copy", ast=ctrl_flow_ast, params=[field_a, field_b])
+
+debug(stencil)

src/gt_toolchain/unstructured/common.py

@@ -51,13 +51,14 @@ class BinaryOperator(StrEnum):
 class DataType(enum.IntEnum):
     """Data type identifier."""
 
-    INVALID = -1
-    AUTO = 0
-    BOOLEAN = 1
-    INT32 = 101
-    UINT32 = 102
-    FLOAT32 = 201
-    FLOAT64 = 202
+    # IDs from dawn
+    INVALID = 0
+    AUTO = 1
+    BOOLEAN = 2
+    INT32 = 3
+    FLOAT32 = 4
+    FLOAT64 = 5
+    UINT32 = 6
 
 
 # TODO not really common

src/gt_toolchain/unstructured/sir.py

@@ -0,0 +1,213 @@
+# -*- coding: utf-8 -*-
+#
+# Eve Toolchain - GT4Py Project - GridTools Framework
+#
+# Copyright (c) 2020, CSCS - Swiss National Supercomputing Center, ETH Zurich
+# All rights reserved.
+#
+# This file is part of the GT4Py project and the GridTools framework.
+# GT4Py is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or any later
+# version. See the LICENSE.txt file at the top-level directory of this
+# distribution for a copy of the license or check <https://www.gnu.org/licenses/>.
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+
+import enum
+from typing import List, Optional, Union
+
+from pydantic import root_validator, validator  # noqa: F401
+
+from eve.core import Node
+
+from . import common
+
+
+# = statements.proto =
+
+
+class Expr(Node):
+    pass
+
+
+class Stmt(Node):
+    pass
+
+
+class AST(Node):
+    root: Stmt
+
+
+@enum.unique
+class LocationType(enum.IntEnum):
+    LocationTypeUnknown = 0
+    Vertex = 1
+    Cell = 2
+    Edge = 3
+
+
+class UnstructuredDimension(Node):
+    dense_location_type: LocationType
+    sparse_part: Optional[Union[LocationType]]
+
+
+class FieldDimensions(Node):
+    horizontal_dimension: Union[UnstructuredDimension]  # TODO CartesianDimension
+    # TODO mask_k: int
+
+
+class Field(Node):  # not to be confused with pydantic.Field
+    name: str
+    is_temporary: bool
+    field_dimensions: FieldDimensions
+
+
+# TODO class Direction
+# TODO class Offset
+# TODO class StencilFunctionArg
+
+
+class Interval(Node):
+    # TODO
+    pass
+
+
+class BuiltinType(Node):
+    type_id: common.DataType
+
+
+# TODO class Dimension
+
+
+class Type(Node):
+    data_type: Union[str, BuiltinType]
+    is_const: bool
+    is_volatile: bool
+
+
+class VerticalRegion(Node):
+    loop_order: common.LoopOrder
+    ast: AST
+    interval: Interval
+    # i_range: Interval
+    # j_range: Interval
+
+
+# TODO class StencilCall
+# TODO class Extents
+# TODO class Accesses
+
+# = statements.proto = AST
+
+
+class BlockStmt(Stmt):
+    statements: List[Stmt]
+
+
+class ExprStmt(Stmt):
+    expr: Expr
+
+
+# TODO class ReturnStmt(Stmt_
+
+
+class VarDeclStmt(Stmt):
+    data_type: Type
+    name: str
+    dimension: int
+    op: str
+    init_list: List[Expr]
+
+
+class VerticalRegionDeclStmt(Stmt):
+    vertical_region: VerticalRegion
+
+
+# TODO class StencilCallDeclStmt(Stmt)
+# TODO class BoundaryConditionDeclStmt(Stmt)
+# TODO class IfStmt(Stmt)
+
+
+class UnaryOperator(Expr):
+    op: str
+    operand: Expr
+    right: Expr
+
+
+class BinaryOperator(Expr):
+    left: Expr
+    op: str
+    right: Expr
+
+
+class AssignmentExpr(Expr):
+    left: Expr
+    op: str
+    right: Expr
+
+
+class TernaryOperator(Expr):
+    cond: Expr
+    left: Expr
+    right: Expr
+
+
+# TODO class FunCallExpr
+# TODO class StencilFunCallExpr
+# TODO class StencilFunArgExpr
+# TODO class VarAccessExpr
+
+
+class ZeroOffset(Node):
+    pass
+
+
+class UnstructuredOffset(Node):
+    has_offset: bool
+
+
+class FieldAccessExpr(Expr):
+    name: str
+    vertical_offset: int
+    horizontal_offset: Union[UnstructuredOffset, ZeroOffset]  # TODO CartesianOffset
+    # TODO argument_map
+    # TODO argument_offset
+    # TODO negate_offset
+    # TODO AccessExprData and ID probably unused in SIR
+
+
+class LiteralExpr(Expr):
+    value: str
+    data_type: BuiltinType
+    # TODO AccessExprData and ID probably unused in SIR
+
+
+class ReductionOverNeighborExpr(Expr):
+    op: str
+    rhs: Expr
+    init: Expr
+    # TODO weights
+    chain: List[LocationType]
+
+
+# = sir.proto =
+
+
+class Stencil(Node):
+    name: str
+    params: List[Field]  # TODO 'fields' would shadow base class 'fields'
+    ast: AST
+
+
+# TODO GlobalVariableMap
+# TODO GlobalVariableValue
+# TODO StencilFunction
+
+
+class SIR(Node):
+    stencils: List[Stencil]
+    filename: str
+    # TODO stencil_functions
+    # TODO global_variables