Files
openfoam/src/finiteArea/areaMesh/areaFaMesh.H
Kutalmis Bercin b393d6eca1 STYLE: finiteArea: add/fix comments
STYLE: finiteArea: consistent use of =delete for removed ctors/assignments
2024-03-05 18:13:59 +00:00

91 lines
2.6 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2016-2017 Wikki Ltd
Copyright (C) 2021 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::areaMesh
Description
Mesh data needed to do the Finite Area discretisation.
Author
Zeljko Tukovic, FMENA
Hrvoje Jasak, Wikki Ltd.
\*---------------------------------------------------------------------------*/
#ifndef areaFaMesh_H
#define areaFaMesh_H
#include "GeoMesh.H"
#include "faMesh.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class areaMesh Declaration
\*---------------------------------------------------------------------------*/
class areaMesh
:
public GeoMesh<faMesh>
{
public:
// Constructors
//- Construct finite-area mesh from faMesh reference
explicit areaMesh(const faMesh& mesh)
:
GeoMesh<faMesh>(mesh)
{}
// Member Functions
//- Return size. Number of faces
static label size(const Mesh& mesh) { return mesh.nFaces(); }
//- Return size. Number of faces
label size() const { return size(mesh_); }
//- Field of face centres
const areaVectorField& C() const { return mesh_.areaCentres(); }
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //