operator.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2023 - 2025 NeoN authors
//
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include "NeoN/linearAlgebra/sparsityPattern.hpp"
#include "NeoN/dsl/coeff.hpp"
 
namespace NeoN::dsl
{
 
class Operator
{
public:
 
    enum class Type
    {
        Implicit,
        Explicit
    };
};
 
 
/* @class OperatorMixin
 * @brief A mixin class to simplify implementations of concrete operators
 * in NeoNs dsl.
 *
 * @detail Operators perform either an explicit or implicit operation on a field or vector.
 *
 * @ingroup dsl
 * @tparam OutType the type of the resulting field after evaluation
 * @tparam InType the type of the input field
 */
template<typename OutType, typename InType = OutType>
class OperatorMixin
{
 
public:
 
    OperatorMixin(
        const Executor exec, const Coeff& coeffs, const InType& field, Operator::Type type
    )
        : exec_(exec), coeffs_(coeffs), field_(field), type_(type) {};
 
    /*@brief return the type of the operator i.e. Implicit or Explicit */
    Operator::Type getType() const { return type_; }
 
    virtual ~OperatorMixin() = default;
 
    virtual const Executor& exec() const final { return exec_; }
 
    Coeff& getCoefficient() { return coeffs_; }
 
    const Coeff& getCoefficient() const { return coeffs_; }
 
    const InType& getVector() const { return field_; }
 
    /* @brief Given an input this function reads required coeffs */
    void read([[maybe_unused]] const Input& input) {}
 
protected:
 
    const Executor exec_; 
 
    Coeff coeffs_;
 
    const InType& field_;
 
    Operator::Type type_;
};
 
} // namespace NeoN::dsl