fieldFromFile.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2012-2015 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::fieldFromFile
28
29Description
30
31SourceFiles
32 fieldFromFile.C
33
34\*---------------------------------------------------------------------------*/
35
36#ifndef fieldFromFile_H
37#define fieldFromFile_H
38
40#include "triSurfaceFields.H"
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47
48class triSurfaceMesh;
49
50/*---------------------------------------------------------------------------*\
51 Class fieldFromFile Declaration
52\*---------------------------------------------------------------------------*/
54class fieldFromFile
55:
57{
58
59private:
60
61 // Private data
62
63 //- Dictionary of coefficients for automatic cell sizing
64 const dictionary& coeffsDict_;
65
66 //- Name of the triSurfaceScalarField file to load in.
67 // Must be in constant/triSurface
68 const word fileName_;
69
70 //- Multiply all the point sizes by this value
71 const scalar cellSizeMultipleCoeff_;
72
73
74public:
75
76 //- Runtime type information
77 TypeName("fieldFromFile");
78
79
80 // Constructors
81
82 //- Construct from components
84 (
85 const dictionary& cellSizeCalcTypeDict,
86 const triSurfaceMesh& surface,
87 const scalar& defaultCellSize
88 );
89
90
91 //- Destructor
92 virtual ~fieldFromFile() = default;
93
94
95 // Member Functions
96
97 //- Load the cell size field
99};
100
101
102// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103
104} // End namespace Foam
105
106// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107
108#endif
109
110// ************************************************************************* //
Abstract base class for specifying target cell sizes.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
fieldFromFile(const dictionary &cellSizeCalcTypeDict, const triSurfaceMesh &surface, const scalar &defaultCellSize)
Construct from components.
TypeName("fieldFromFile")
Runtime type information.
virtual ~fieldFromFile()=default
Destructor.
virtual tmp< triSurfacePointScalarField > load()
Load the cell size field.
A class for managing temporary objects.
Definition: tmp.H:65
IOoject and searching on triSurface.
A class for handling words, derived from Foam::string.
Definition: word.H:68
Namespace for OpenFOAM.
Fields for triSurface.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73