automatic.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 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::automatic
28 
29 Description
30 
31 SourceFiles
32  automatic.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef automatic_H
37 #define automatic_H
38 
40 #include "triSurfaceFields.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 class triSurfaceMesh;
49 
50 /*---------------------------------------------------------------------------*\
51  Class automatic Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class automatic
55 :
57 {
58  // Private data
59 
60  //- Dictionary of coefficients for automatic cell sizing
61  const dictionary& coeffsDict_;
62 
63  //- Name of the surface. Used to write the cell size field
64  const fileName surfaceName_;
65 
66  const bool readCurvature_;
67  const bool readFeatureProximity_;
68  const bool readInternalCloseness_;
69 
70  const word curvatureFile_;
71  const word featureProximityFile_;
72  const word internalClosenessFile_;
73 
74  //- The curvature values are multiplied by the inverse of this value to
75  // get the cell size
76  const scalar curvatureCellSizeCoeff_;
77 
78  //- The maximum allowable sell size
79  const scalar maximumCellSize_;
80 
81 
82  // Private Member Functions
83 
84  void smoothField(triSurfaceScalarField& surf);
85 
86 
87 public:
88 
89  //- Runtime type information
90  TypeName("automatic");
91 
92 
93  // Constructors
94 
95  //- Construct from components
96  automatic
97  (
98  const dictionary& cellSizeCalcTypeDict,
99  const triSurfaceMesh& surface,
100  const scalar defaultCellSize
101  );
102 
103 
104  //- Destructor
105  virtual ~automatic() = default;
106 
107 
108  // Member Functions
109 
110  //- Load the cell size field
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************************************************************* //
Foam::automatic::automatic
automatic(const dictionary &cellSizeCalcTypeDict, const triSurfaceMesh &surface, const scalar defaultCellSize)
Construct from components.
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::fileName
A class for handling file names.
Definition: fileName.H:73
PrimitivePatchInterpolation.H
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
triSurfaceFields.H
Fields for triSurface.
Foam::triSurfaceMesh
IOoject and searching on triSurface.
Definition: triSurfaceMesh.H:106
Foam::automatic::load
virtual tmp< triSurfacePointScalarField > load()
Load the cell size field.
Foam::automatic::~automatic
virtual ~automatic()=default
Destructor.
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
cellSizeCalculationType.H
Foam::automatic::TypeName
TypeName("automatic")
Runtime type information.
Foam::cellSizeCalculationType
Abstract base class for specifying target cell sizes.
Definition: cellSizeCalculationType.H:54
Foam::automatic
Definition: automatic.H:53
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54