zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

DOC: additional documentation in MappedFile

Browse Source
This commit is contained in:
Mark Olesen
2020-06-25 11:32:54 +02:00
parent 0a7eb6e6dc
commit 7b7142536d
1 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/meshTools/PatchFunction1/MappedFile/MappedFile.H
View File

@ -5,7 +5,7 @@
\\ / A nd | www.openfoam.com \\ / A nd | www.openfoam.com
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Copyright (C) 2018 OpenCFD Ltd. Copyright (C) 2018-2020 OpenCFD Ltd.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
This file is part of OpenFOAM. This file is part of OpenFOAM.
@ -27,6 +27,18 @@ Class
Foam::PatchFunction1Types::MappedFile Foam::PatchFunction1Types::MappedFile
Description Description
Patch value mapping from file
Options:
\table
Property | Description | Required | Default
mapMethod | (nearest/planarInterpolation) | no | planarInterpolation
offset | Time-varying offset values to interpolated data | no |
fieldTable | Name of field data table | no | field-name
points | The name of the points file | no | points
perturb | Perturbation fraction of bounding box | no | 1e-5
setAverage | adjust mapped field to maintain average value | no | false
\endtable
SourceFiles SourceFiles
MappedFile.C MappedFile.C
@ -56,7 +68,7 @@ class MappedFile
: :
public PatchFunction1<Type> public PatchFunction1<Type>
{ {
// Private data // Private Data
//- Whether constructed from dictionary //- Whether constructed from dictionary
const bool dictConstructed_; const bool dictConstructed_;
@ -65,7 +77,7 @@ class MappedFile
word fieldTableName_; word fieldTableName_;
//- If true adjust the mapped field to maintain average value //- If true adjust the mapped field to maintain average value
Switch setAverage_; bool setAverage_;
//- Fraction of perturbation (fraction of bounding box) to add //- Fraction of perturbation (fraction of bounding box) to add
scalar perturb_; scalar perturb_;
@ -114,7 +126,7 @@ class MappedFile
public: public:
// Runtime type information //- Runtime type information
TypeName("mappedFile"); TypeName("mappedFile");