mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-12-28 03:37:59 +00:00
02edc5b206
- disable automatically upgrading copyrights in files since changes to not automatically imply a change in copyright. Eg, fixing a typo in comments, or changing a variable from 'loopI' to 'loopi' etc.
162 lines
4.4 KiB
C++
162 lines
4.4 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2015 OpenCFD Ltd.
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
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::surfaceReader
|
|
|
|
Description
|
|
Base class for surface readers
|
|
|
|
SourceFiles
|
|
surfaceReader.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef surfaceReader_H
|
|
#define surfaceReader_H
|
|
|
|
#include "typeInfo.H"
|
|
#include "autoPtr.H"
|
|
#include "MeshedSurfaces.H"
|
|
#include "runTimeSelectionTables.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class surfaceReader Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class surfaceReader
|
|
{
|
|
protected:
|
|
|
|
//- File name
|
|
fileName fileName_;
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("surfaceReader");
|
|
|
|
// Declare run-time constructor selection table
|
|
|
|
declareRunTimeSelectionTable
|
|
(
|
|
autoPtr,
|
|
surfaceReader,
|
|
fileName,
|
|
(
|
|
const fileName& fName
|
|
),
|
|
(fName)
|
|
);
|
|
|
|
|
|
// Selectors
|
|
|
|
//- Return a reference to the selected surfaceReader
|
|
static autoPtr<surfaceReader> New
|
|
(
|
|
const word& readType,
|
|
const fileName& fName
|
|
);
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from fileName
|
|
surfaceReader(const fileName& fName);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~surfaceReader();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Return a reference to the surface geometry
|
|
virtual const meshedSurface& geometry() = 0;
|
|
|
|
//- Return a list of the available times
|
|
virtual instantList times() const = 0;
|
|
|
|
//- Return a list of the available fields at a given time
|
|
virtual wordList fieldNames(const label timeIndex) const = 0;
|
|
|
|
//- Return a scalar field at a given time
|
|
virtual tmp<Field<scalar>> field
|
|
(
|
|
const label timeIndex,
|
|
const label fieldIndex,
|
|
const scalar& refValue = pTraits<scalar>::zero
|
|
) const = 0;
|
|
|
|
//- Return a vector field at a given time
|
|
virtual tmp<Field<vector>> field
|
|
(
|
|
const label timeIndex,
|
|
const label fieldIndex,
|
|
const vector& refValue = pTraits<vector>::zero
|
|
) const = 0;
|
|
|
|
//- Return a sphericalTensor field at a given time
|
|
virtual tmp<Field<sphericalTensor>> field
|
|
(
|
|
const label timeIndex,
|
|
const label fieldIndex,
|
|
const sphericalTensor& reValue = pTraits<sphericalTensor>::zero
|
|
) const = 0;
|
|
|
|
//- Return a symmTensor field at a given time
|
|
virtual tmp<Field<symmTensor>> field
|
|
(
|
|
const label timeIndex,
|
|
const label fieldIndex,
|
|
const symmTensor& reValue = pTraits<symmTensor>::zero
|
|
) const = 0;
|
|
|
|
//- Return a tensor field at a given time
|
|
virtual tmp<Field<tensor>> field
|
|
(
|
|
const label timeIndex,
|
|
const label fieldIndex,
|
|
const tensor& reValue = pTraits<tensor>::zero
|
|
) const = 0;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|