File size: 7,081 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionObjects::sampledSurfaces
Description
Set of surfaces to sample
Example of function object specification:
\verbatim
surfaces1
{
type surfaces;
libs ("libsampling.so");
writeControl writeTime;
fields (p U);
surfaceFormat vtk;
interpolationScheme cellPoint;
surfaces
(
p1e5
{
type isoSurface;
isoField p;
isoValue 1e5;
interpolate yes;
}
);
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
type | type name: surfaces | yes |
surfaceFormat | the format in which to write the surface file | yes |
interpolationScheme | the method by which values are interpolated \\
from the mesh to the surface | yes
writeEmpty | write out files for empty surfaces | no | no
surfaces | the list of surfaces | yes |
\endtable
See also
Foam::sampledSurfaces
SourceFiles
sampledSurfaces.C
\*---------------------------------------------------------------------------*/
#ifndef sampledSurfaces_functionObject_H
#define sampledSurfaces_functionObject_H
#include "fvMeshFunctionObject.H"
#include "sampledSurface.H"
#include "surfaceWriter.H"
#include "volFieldsFwd.H"
#include "surfaceFieldsFwd.H"
#include "IOobjectList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class Time;
class fvMesh;
class dictionary;
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class sampledSurfaces Declaration
\*---------------------------------------------------------------------------*/
class sampledSurfaces
:
public fvMeshFunctionObject,
public PtrList<sampledSurface>
{
// Private classes
//- Class used for surface merging information
class mergeInfo
{
public:
pointField points;
faceList faces;
labelList pointsMap;
//- Clear all storage
void clear()
{
points.clear();
faces.clear();
pointsMap.clear();
}
};
// Static Data Members
//- Tolerance for merging points (fraction of mesh bounding box)
static scalar mergeTol_;
// Private Data
//- Output path
fileName outputPath_;
// Read from dictionary
//- Names of fields to sample
wordList fields_;
//- Interpolation scheme to use
word interpolationScheme_;
//- Should we create files for empty surfaces?
Switch writeEmpty_;
// Surfaces
//- Information for merging surfaces
List<mergeInfo> mergeList_;
// Calculated
//- Surface formatter
autoPtr<surfaceWriter> formatter_;
// Private Member Functions
//- Does any of the surfaces need an update?
bool needsUpdate() const;
//- Update the surfaces as required and merge surface points (parallel).
// Return false if no surfaces required an update.
bool update();
//- Sample all fields of a type on a given surface
template<class Type>
PtrList<Field<Type>> sampleLocalType
(
const label surfi,
const wordList& fieldNames,
HashPtrTable<interpolation<Type>>& interpolations
);
//- Sample all fields of a type on a given surface and combine on the
// master for writing
template<class Type>
PtrList<Field<Type>> sampleType
(
const label surfi,
const wordList& fieldNames,
HashPtrTable<interpolation<Type>>& interpolations
);
public:
//- Runtime type information
TypeName("surfaces");
// Constructors
//- Construct from Time and dictionary
sampledSurfaces
(
const word& name,
const Time& time,
const dictionary& dict
);
//- Disallow default bitwise copy construction
sampledSurfaces(const sampledSurfaces&) = delete;
//- Destructor
virtual ~sampledSurfaces();
// Member Functions
//- Read the sampledSurfaces dictionary
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const;
//- Execute, currently does nothing
virtual bool execute();
//- Sample and write
virtual bool write();
//- Update for mesh point-motion
virtual void movePoints(const polyMesh&);
//- Update topology using the given map
virtual void topoChange(const polyTopoChangeMap&);
//- Update from another mesh using the given map
virtual void mapMesh(const polyMeshMap&);
//- Redistribute or update using the given distribution map
virtual void distribute(const polyDistributionMap&);
// Member Operators
//- Disallow default bitwise assignment
void operator=(const sampledSurfaces&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "sampledSurfacesTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|