yask_kernel_api.hpp

Go to the documentation of this file.

/*****************************************************************************
 
YASK: Yet Another Stencil Kit
Copyright (c) 2014-2023, 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 uses Doxygen markup for API documentation-generation.
// See https://www.doxygen.nl/manual/index.html.
#pragma once
 
#include "yask_common_api.hpp"
#include <vector>
#include <cinttypes>
 
#ifndef MPI_VERSION
typedef int MPI_Comm;
#endif
 
namespace yask {
 
    // Forward declarations of classes and pointers.
 
    class yk_env;
    typedef std::shared_ptr<yk_env> yk_env_ptr;
 
    class yk_solution;
    typedef std::shared_ptr<yk_solution> yk_solution_ptr;
 
    class yk_var;
    typedef std::shared_ptr<yk_var> yk_var_ptr;
 
    class yk_stats;
    typedef std::shared_ptr<yk_stats> yk_stats_ptr;
 
} // namespace yask.
 
#include "aux/yk_solution_api.hpp"
#include "aux/yk_var_api.hpp"
 
namespace yask {
 
    class yk_factory {
    public:
        yk_factory();
        virtual ~yk_factory() {}
 
 
        virtual std::string
        get_version_string();
 
 
        virtual yk_env_ptr
        new_env() const;
 
 
        virtual yk_env_ptr
        new_env(MPI_Comm comm) const;
 
 
        virtual yk_solution_ptr
        new_solution(yk_env_ptr env ) const;
 
 
        virtual yk_solution_ptr
        new_solution(yk_env_ptr env ,
                     const yk_solution_ptr source ) const;
    }; // yk_factory.
 
 
    class yk_env {
    public:
        virtual ~yk_env() {}
 
 
        static void
        set_debug_output(yask_output_ptr debug );
 
 
        static void
        disable_debug_output();
 
 
        static yask_output_ptr
        get_debug_output();
 
 
        static inline void
        print_splash(int argc, char** argv,
                     std::string invocation_leader = "invocation: ") {
            yask_print_splash(get_debug_output()->get_ostream(),
                              argc, argv, invocation_leader);
        }
        
 
        static void
        set_trace_enabled(bool enable);
 
 
        static bool
        is_trace_enabled();
 
 
        virtual int
        get_num_ranks() const =0;
 
 
        virtual int
        get_rank_index() const =0;
 
 
        virtual void
        global_barrier() const =0;
 
 
        virtual idx_t
        sum_over_ranks(idx_t rank_val) const =0;
 
 
        virtual void
        assert_equality_over_ranks(idx_t rank_val,
                                   const std::string& descr) const =0;
 
 
        virtual void
        finalize() =0;
 
        YASK_NORETURN virtual void
        exit(int code) =0;
 
    }; // yk_env.
 
    YASK_DEPRECATED
    typedef yk_var yk_grid;
    YASK_DEPRECATED
    typedef yk_var_ptr yk_grid_ptr;
 
} // namespace yask.