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