geometryScheme.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2023 - 2025 NeoN authors
//
// SPDX-License-Identifier: MIT
 
#pragma once
 
 
#include "NeoN/core/primitives/vec3.hpp"
#include "NeoN/core/primitives/scalar.hpp"
#include "NeoN/core/executor/executor.hpp"
#include "NeoN/finiteVolume/cellCentred/fields/surfaceField.hpp"
#include "NeoN/mesh/unstructured/unstructuredMesh.hpp"
 
namespace NeoN::finiteVolume::cellCentred
{
 
class GeometrySchemeFactory
{
 
public:
 
    GeometrySchemeFactory(const UnstructuredMesh& mesh);
 
    virtual ~GeometrySchemeFactory() = default;
 
    virtual void updateWeights(const Executor& exec, SurfaceField<scalar>& weights) = 0;
 
    virtual void updateDeltaCoeffs(const Executor& exec, SurfaceField<scalar>& deltaCoeffs) = 0;
 
    virtual void
    updateNonOrthDeltaCoeffs(const Executor& exec, SurfaceField<scalar>& nonOrthDeltaCoeffs) = 0;
 
    virtual void
    updateNonOrthDeltaCoeffs(const Executor& exec, SurfaceField<Vec3>& nonOrthDeltaCoeffs) = 0;
};
 
/* @class GeometryScheme
 * @brief Implements a method to compute deltaCoeffs
 */
class GeometryScheme
{
public:
 
    GeometryScheme(
        const Executor& exec,
        std::unique_ptr<GeometrySchemeFactory> kernel,
        const SurfaceField<scalar>& weights,
        const SurfaceField<scalar>& deltaCoeffs,
        const SurfaceField<scalar>& nonOrthDeltaCoeffs,
        const SurfaceField<Vec3>& nonOrthCorrectionVec3s
    );
 
    GeometryScheme(
        const Executor& exec,
        const UnstructuredMesh& mesh,
        std::unique_ptr<GeometrySchemeFactory> kernel
    );
 
    GeometryScheme(const UnstructuredMesh& mesh // will lookup the kernel
    );
 
    virtual ~GeometryScheme() = default;
 
    const SurfaceField<scalar>& weights() const;
 
    const SurfaceField<scalar>& deltaCoeffs() const;
 
    const SurfaceField<scalar>& nonOrthDeltaCoeffs() const;
 
    const SurfaceField<Vec3>& nonOrthCorrectionVec3s() const;
 
    void update();
 
    std::string name() const;
 
    // add selection mechanism via dictionary later
    static const std::shared_ptr<GeometryScheme> readOrCreate(const UnstructuredMesh& mesh);
 
private:
 
    const Executor exec_;
    const UnstructuredMesh& mesh_;
    std::unique_ptr<GeometrySchemeFactory> kernel_;
 
    SurfaceField<scalar> weights_;
    SurfaceField<scalar> deltaCoeffs_;
    SurfaceField<scalar> nonOrthDeltaCoeffs_;
    SurfaceField<Vec3> nonOrthCorrectionVec3s_;
};
 
} // namespace NeoN