surfaceFeaturesConfiguration.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) 2023-2025 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::surfaceFeaturesConfiguration
26 
27 Description
28  From a set of input surface geometry files and some configuration
29  parameters, writes out a surfacesFeaturesDict configuration file.
30 
31 SourceFiles
32  surfaceFeaturesConfiguration.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef surfaceFeaturesConfiguration_H
37 #define surfaceFeaturesConfiguration_H
38 
39 #include "caseFileConfiguration.H"
40 #include "meshingSurfaceList.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class surfaceFeaturesConfiguration Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
54 {
55 protected:
56 
57  // Protected Data
58 
59  //- List of surfaces used for generating features
61 
62 
63  // Protected Member Functions
64 
65  //- Write surfaces
66  void writeSurfaces();
67 
68  //- Write subsetFeatures sub-dictionary
69  void writeSubsetFeatures();
70 
71  //- Write trimFeatures sub-dictionary
72  void writeTrimFeatures();
73 
74 public:
75 
76  // Constructors
77 
78  //- Construct from components
80  (
81  const fileName& name,
82  const fileName& dir,
83  const Time& time,
84  const meshingSurfaceList& surfaces
85  );
86 
87  //- Disallow default bitwise copy construction
89  (
91  ) = delete;
92 
93 
94  //- Destructor
96 
97 
98  // Member Functions
99 
100  // Writing surfaceFeaturesDict
101  void write();
102 
103 
104  // Member Operators
105 
106  //- Disallow default bitwise assignment
107  void operator=(const surfaceFeaturesConfiguration&) = delete;
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
Base class for writing case files.
A class for handling file names.
Definition: fileName.H:82
List of meshingSurfaces which stores the overall bounding box of all the meshingSurfaces.
From a set of input surface geometry files and some configuration parameters, writes out a surfacesFe...
void operator=(const surfaceFeaturesConfiguration &)=delete
Disallow default bitwise assignment.
surfaceFeaturesConfiguration(const fileName &name, const fileName &dir, const Time &time, const meshingSurfaceList &surfaces)
Construct from components.
void writeSubsetFeatures()
Write subsetFeatures sub-dictionary.
const meshingSurfaceList & surfaces_
List of surfaces used for generating features.
void writeSurfaces()
Write surfaces.
void writeTrimFeatures()
Write trimFeatures sub-dictionary.
Namespace for OpenFOAM.
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.