yc_solution_api.hpp

Go to the documentation of this file.

/*****************************************************************************
 
YASK: Yet Another Stencil Kit
Copyright (c) 2014-2024, Intel Corporation
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
* The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
 
*****************************************************************************/
 
// This file contains a base class and macros to create
// stencils to be included in the YASK compiler binary utility.
 
// This file uses Doxygen markup for API documentation-generation.
// See https://www.doxygen.nl/manual/index.html.
#pragma once
 
// Standard headers.
#include <cassert>
#include <map>
 
namespace yask {
 
 
    class yc_solution_base {
 
    public:
 
        typedef std::map<std::string, yc_solution_base*> soln_map;
        
    private:
 
        yc_solution_ptr _soln;
 
        yc_factory _yc_factory;
 
        yc_node_factory _node_factory;
 
    public:
 
 
        yc_solution_base(const std::string& name);
 
 
        yc_solution_base(yc_solution_base& base);
 
        virtual ~yc_solution_base() { }
 
 
        static soln_map& get_registry();
 
 
        virtual void
        define();
 
        inline yc_solution_ptr
        get_soln() {
            return _soln;
        }
 
        inline yc_index_node_ptr
        new_step_index(const std::string& name) {
            return _node_factory.new_step_index(name);
        }
 
        inline yc_index_node_ptr
        new_domain_index(const std::string& name) {
            return _node_factory.new_domain_index(name);
        }
 
        inline yc_index_node_ptr
        new_misc_index(const std::string& name) {
            return _node_factory.new_misc_index(name);
        }
 
        inline yc_number_node_ptr
        new_number_node(yc_number_any_arg arg) {
            return _node_factory.new_number_node(arg);
        }
 
        inline yc_number_node_ptr
        first_domain_index(yc_index_node_ptr dim) {
            return _node_factory.new_first_domain_index(dim);
        }
 
        inline yc_number_node_ptr
        last_domain_index(yc_index_node_ptr dim) {
            return _node_factory.new_last_domain_index(dim);
        }
    };
 
 
    class yc_solution_with_radius_base : public yc_solution_base {
    private:
 
        int _radius;
 
    public:
        yc_solution_with_radius_base(const std::string& name, int radius) :
            yc_solution_base(name) {
            set_radius(radius);
        }
 
 
        virtual void
        define() override;
 
 
        virtual bool
        set_radius(int radius) {
            _radius = radius;
            auto soln = get_soln();
            soln->set_description(soln->get_name() + " radius " + std::to_string(radius));
            return radius >= 0;  // support only non-neg. radius.
        }
 
 
        virtual int
        get_radius() const {
            return _radius;
        }
    };
 
    /*** Example: `MAKE_STEP_INDEX(t)` */
    #define MAKE_STEP_INDEX(dim_name)   yc_index_node_ptr dim_name = new_step_index(#dim_name)
    
    /*** Example: `MAKE_DOMAIN_INDEX(x)` */
    #define MAKE_DOMAIN_INDEX(dim_name) yc_index_node_ptr dim_name = new_domain_index(#dim_name)
 
    /*** Example: `MAKE_MISC_INDEX(a)` */
    #define MAKE_MISC_INDEX(dim_name)   yc_index_node_ptr dim_name = new_misc_index(#dim_name)
 
    /*** Example: `MAKE_VAR(pressure, t, x, y, z)` */
    #define MAKE_VAR(var_name, ...)                                     \
        yc_var_proxy var_name = yc_var_proxy(#var_name, get_soln(), { __VA_ARGS__ }, false)
    
    #define MAKE_SCRATCH_VAR(var_name, ...)                             \
        yc_var_proxy var_name = yc_var_proxy(#var_name, get_soln(), { __VA_ARGS__ }, true)
    
    #define MAKE_SCALAR_VAR(var_name) MAKE_VAR(var_name)
 
    // and registering it in the list used by the YASK compiler binary.
    #define REGISTER_SOLUTION(class_name)               \
        static class_name class_name ## _instance
    
} // namespace yask.