coeff.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: MIT
// SPDX-FileCopyrightText: 2023 NeoFOAM authors
#pragma once
 
#include "NeoFOAM/core/primitives/scalar.hpp"
#include "NeoFOAM/fields/field.hpp"
 
namespace NeoFOAM::dsl
{
 
class Coeff
{
 
public:
 
    Coeff();
 
    Coeff(scalar value);
 
    Coeff(scalar coeff, const Field<scalar>& field);
 
    Coeff(const Field<scalar>& field);
 
    KOKKOS_INLINE_FUNCTION
    scalar operator[](const size_t i) const { return (hasSpan_) ? span_[i] * coeff_ : coeff_; }
 
    bool hasSpan();
 
    std::span<const scalar> span();
 
    Coeff& operator*=(scalar rhs);
 
 
    Coeff& operator*=(const Coeff& rhs);
 
 
private:
 
    scalar coeff_;
 
    std::span<const scalar> span_;
 
    bool hasSpan_;
};
 
 
[[nodiscard]] inline Coeff operator*(const Coeff& lhs, const Coeff& rhs)
{
    Coeff result = lhs;
    result *= rhs;
    return result;
}
 
namespace detail
{
/* @brief function to force evaluation to a field, the field will be resized to hold either a
 * single value or the full field
 *
 * @param field to store the result
 */
void toField(Coeff& coeff, Field<scalar>& rhs);
 
} // namespace detail
 
} // namespace NeoFOAM::dsl