fixedValue.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2023 - 2026 NeoN authors
//
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <Kokkos_Core.hpp>
 
#include "NeoN/fields/field.hpp"
#include "NeoN/finiteVolume/cellCentred/boundary/volumeBoundaryFactory.hpp"
#include "NeoN/mesh/unstructured/unstructuredMesh.hpp"
#include "NeoN/core/parallelAlgorithms.hpp"
 
namespace NeoN::finiteVolume::cellCentred::volumeBoundary
{
 
namespace detail
{
// TODO move to source
// Without this function the compiler warns that calling a __host__ function
// from a __device__ function is not allowed
template<typename ValueType>
void setFixedValue(
    Field<ValueType>& domainVector, std::pair<size_t, size_t> range, ValueType fixedValue
)
{
    auto [refGradient, value, valueFraction, refValue] = views(
        domainVector.boundaryData().refGrad(),
        domainVector.boundaryData().value(),
        domainVector.boundaryData().valueFraction(),
        domainVector.boundaryData().refValue()
    );
 
    NeoN::parallelFor(
        domainVector.exec(),
        range,
        NEON_LAMBDA(const localIdx i) {
            refValue[i] = fixedValue;
            value[i] = fixedValue;
            valueFraction[i] = 1.0;      // only used refValue
            refGradient[i] = fixedValue; // not used
        },
        "setFixedValueVolume"
    );
}
 
}
 
template<typename ValueType>
class FixedValue : public VolumeBoundaryFactory<ValueType>::template Register<FixedValue<ValueType>>
{
    using Base = VolumeBoundaryFactory<ValueType>::template Register<FixedValue<ValueType>>;
 
public:
 
    using Base::correctBoundaryCondition;
 
    FixedValue(const UnstructuredMesh& mesh, const Dictionary& dict, localIdx patchID)
        : Base(mesh, dict, patchID, {.assignable = false, .fixesValue = true}),
          fixedValue_(dict.get<ValueType>("fixedValue"))
    {}
 
    virtual void correctBoundaryCondition(Field<ValueType>& domainVector) final
    {
        detail::setFixedValue(domainVector, this->range(), fixedValue_);
    }
 
    static std::string name() { return "fixedValue"; }
 
    std::string getName() const override { return name(); }
 
    static std::string doc() { return "Set a fixed value on the boundary"; }
 
    static std::string schema() { return "none"; }
 
    virtual std::unique_ptr<VolumeBoundaryFactory<ValueType>> clone() const final
    {
        return std::make_unique<FixedValue>(*this);
    }
 
private:
 
    ValueType fixedValue_;
};
 
}