cellSizeAndAlignmentControls.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::cellSizeAndAlignmentControls
28
29Description
30
31SourceFiles
32 cellSizeAndAlignmentControls.C
33
34\*---------------------------------------------------------------------------*/
35
36#ifndef cellSizeAndAlignmentControls_H
37#define cellSizeAndAlignmentControls_H
38
39#include "dictionary.H"
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46
47/*---------------------------------------------------------------------------*\
48 Class cellSizeAndAlignmentControls Declaration
49\*---------------------------------------------------------------------------*/
52{
53 // Private data
54
55 const dictionary& shapeControlDict_;
56
57 const conformationSurfaces& geometryToConformTo_;
58
60
61 const scalar defaultCellSize_;
62
63
64 // Private Member Functions
65
66 bool evalCellSizeFunctions
67 (
68 const point& pt,
69 scalar& minSize,
70 label& maxPriority
71 ) const;
72
73 //- No copy construct
75 (
77 ) = delete;
78
79 //- No copy assignment
80 void operator=(const cellSizeAndAlignmentControls&) = delete;
81
82
83public:
84
85 //- Runtime type information
86 ClassName("cellSizeAndAlignmentControls");
87
88
89 // Constructors
90
91 //- Construct from dictionary
93 (
94 const Time& runTime,
95 const dictionary& shapeControlDict,
97 const scalar& defaultCellSize
98 );
99
100
101 //- Destructor
103
104
105 // Member Functions
106
107 // Access
108
110 controlFunctions() const
111 {
112 return controlFunctions_;
113 }
115 inline const conformationSurfaces& geometryToConformTo() const
116 {
117 return geometryToConformTo_;
118 }
119
120
121 // Query
123 scalar cellSize(const point& pt) const;
125 scalar cellSize(const point& pt, label& maxPriority) const;
126};
127
128
129// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130
131} // End namespace Foam
132
133// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134
135#endif
136
137// ************************************************************************* //
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition: PtrList.H:73
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:80
const PtrList< cellSizeAndAlignmentControl > & controlFunctions() const
const conformationSurfaces & geometryToConformTo() const
virtual ~cellSizeAndAlignmentControls()
Destructor.
ClassName("cellSizeAndAlignmentControls")
Runtime type information.
scalar cellSize(const point &pt, label &maxPriority) const
scalar cellSize(const point &pt) const
cellSizeAndAlignmentControls(const Time &runTime, const dictionary &shapeControlDict, const conformationSurfaces &geometryToConformTo, const scalar &defaultCellSize)
Construct from dictionary.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
#define ClassName(TypeNameString)
Add typeName information from argument TypeNameString to a class.
Definition: className.H:67
engineTime & runTime
Namespace for OpenFOAM.