geometricField.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: MIT
// SPDX-FileCopyrightText: 2024 NeoFOAM authors
 
#pragma once
 
#include "NeoFOAM/core/executor/executor.hpp"
#include "NeoFOAM/fields/field.hpp"
#include "NeoFOAM/fields/domainField.hpp"
#include "NeoFOAM/mesh/unstructured/unstructuredMesh.hpp"
#include "NeoFOAM/fields/boundaryFields.hpp"
 
namespace NeoFOAM::finiteVolume::cellCentred
{
 
template<typename ValueType>
class GeometricFieldMixin
{
public:
 
    GeometricFieldMixin(
        const Executor& exec,
        std::string fieldName,
        const UnstructuredMesh& mesh,
        const DomainField<ValueType>& field
    )
        : name(fieldName), exec_(exec), mesh_(mesh), field_(field)
    {}
 
    GeometricFieldMixin(
        const Executor& exec,
        std::string fieldName,
        const UnstructuredMesh& mesh,
        const Field<ValueType>& internalField,
        const BoundaryFields<ValueType>& boundaryFields
    )
        : name(fieldName), exec_(exec), mesh_(mesh), field_({exec, internalField, boundaryFields})
    {
        if (mesh.nCells() != internalField.size())
        {
            NF_ERROR_EXIT("Inconsistent size of mesh and internal field detected");
        }
    }
 
    const Field<ValueType>& internalField() const { return field_.internalField(); }
 
    Field<ValueType>& internalField() { return field_.internalField(); }
 
    size_t size() const { return field_.internalField().size(); }
 
    const BoundaryFields<ValueType>& boundaryField() const { return field_.boundaryField(); }
 
    BoundaryFields<ValueType>& boundaryField() { return field_.boundaryField(); }
 
    const Executor& exec() const { return exec_; }
 
    const UnstructuredMesh& mesh() const { return mesh_; }
 
    std::string name; // The name of the field
 
protected:
 
    Executor exec_;                // The executor object
    const UnstructuredMesh& mesh_; // The unstructured mesh object
    DomainField<ValueType> field_; // The domain field object
};
 
} // namespace NeoFOAM