OpenFOAM: API Guide
v2112
The open source CFD toolbox
extractFromFile.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) 2017 OpenCFD Ltd.
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::surfaceFeaturesExtraction::extractFromFile
28
29
Description
30
Run-time selectable surface feature extraction.
31
32
Selectable as "extractFromFile".
33
Mandatory dictionary entries: "featureEdgeFile".
34
Optional dictionary entries: "geometricTestOnly".
35
36
SourceFiles
37
extractFromFile.C
38
39
\*---------------------------------------------------------------------------*/
40
41
#ifndef surfaceFeaturesExtraction_extractFromFile_H
42
#define surfaceFeaturesExtraction_extractFromFile_H
43
44
#include "
surfaceFeaturesExtraction.H
"
45
46
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47
48
namespace
Foam
49
{
50
namespace
surfaceFeaturesExtraction
51
{
52
53
/*---------------------------------------------------------------------------*\
54
Class surfaceFeaturesExtraction::extractFromFile Declaration
55
\*---------------------------------------------------------------------------*/
56
57
class
extractFromFile
58
:
59
public
method
60
{
61
fileName
featureEdgeFile_;
62
63
64
public
:
65
66
//- Construct from dictionary
67
extractFromFile
(
const
dictionary
&
dict
);
68
69
//- Destructor
70
virtual
~extractFromFile
();
71
72
//- Features loaded (extracted) from featureEdgeFile
73
virtual
autoPtr<surfaceFeatures>
features
74
(
75
const
triSurface
& surf
76
)
const override
;
77
78
};
79
80
81
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82
83
}
// End namespace surfaceFeaturesExtraction
84
}
// End namespace Foam
85
86
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87
88
#endif
89
90
// ************************************************************************* //
Foam::surfaceFeaturesExtraction::extractFromFile::features
virtual autoPtr< surfaceFeatures > features(const triSurface &surf) const override
Features loaded (extracted) from featureEdgeFile.
Foam::fileName
A class for handling file names.
Definition:
fileName.H:73
Foam::surfaceFeaturesExtraction::method
Abstract base for run-time selectable surface feature extraction methods.
Definition:
surfaceFeaturesExtraction.H:61
surfaceFeaturesExtraction.H
Foam::surfaceFeaturesExtraction::extractFromFile::extractFromFile
extractFromFile(const dictionary &dict)
Construct from dictionary.
Foam::triSurface
Triangulated surface description with patch information.
Definition:
triSurface.H:76
dict
dictionary dict
Definition:
searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition:
dictionary.H:123
Foam::surfaceFeaturesExtraction::extractFromFile::~extractFromFile
virtual ~extractFromFile()
Destructor.
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition:
HashPtrTable.H:53
Foam::surfaceFeaturesExtraction::extractFromFile
Run-time selectable surface feature extraction.
Definition:
extractFromFile.H:56
applications
utilities
surface
surfaceFeatureExtract
extractionMethod
extractFromFile.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.