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: elaborate the usage of function objects

Browse Source 
ENH: update libs of etc/caseDicts/postProcess items
  ENH: ensure destructor=default
  ENH: ensure constness
  ENH: ensure no 'copy construct' and 'no copy assignment' exist
  TUT: add examples of function objects with full set
       of settings into a TUT if unavailable
  TUT: update pisoFoam/RAS/cavity tutorial in terms of usage
This commit is contained in:
Kutalmis Bercin
2020-03-13 18:49:58 +00:00
committed by Andrew Heather
parent b549116588
commit a5c6516e23
264 changed files with 7120 additions and 2830 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/functionObjects/field/particleDistribution/particleDistribution.C
View File

@ -5,7 +5,7 @@
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2016 OpenCFD Ltd.
Copyright (C) 2016-2020 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@ -38,7 +38,6 @@ namespace Foam
namespace functionObjects
{
defineTypeNameAndDebug(particleDistribution, 0);
addToRunTimeSelectionTable
(
functionObject,
@ -61,21 +60,15 @@ Foam::functionObjects::particleDistribution::particleDistribution
fvMeshFunctionObject(name, runTime, dict),
writeFile(runTime, name),
cloudName_("unknown-cloudName"),
nameVsBinWidth_(),
tagFieldName_("none"),
rndGen_(),
nameVsBinWidth_(),
writerPtr_(nullptr)
{
read(dict);
}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
Foam::functionObjects::particleDistribution::~particleDistribution()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
bool Foam::functionObjects::particleDistribution::read(const dictionary& dict)
@ -83,8 +76,8 @@ bool Foam::functionObjects::particleDistribution::read(const dictionary& dict)
if (fvMeshFunctionObject::read(dict) && writeFile::read(dict))
{
dict.readEntry("cloud", cloudName_);
dict.readEntry("nameVsBinWidth", nameVsBinWidth_);
dict.readIfPresent("tagField", tagFieldName_);
dict.readEntry("nameVsBinWidth", nameVsBinWidth_);
const word format(dict.get<word>("setFormat"));
writerPtr_ = writer<scalar>::New(format);

72
src/functionObjects/field/particleDistribution/particleDistribution.H
View File

@ -32,40 +32,66 @@ Group
Description
Generates a particle distribution for lagrangian data at a given time.
Operands:
\table
Operand | Type | Location
input | - | -
output file | dat | $FOAM_CASE/postProcessing/\<FO\>/\<time\>/\<file\>
output field | - | -
\endtable
Usage
Minimal example by using \c system/controlDict.functions:
\verbatim
particleDistribution1
{
// Mandatory entries (unmodifiable)
type particleDistribution;
libs (fieldFunctionObjects);
...
cloud "myCloud";
// Mandatory entries (runtime modifiable)
cloud <cloudName>;
nameVsBinWidth
(
(d 0.1)
(U 10)
);
setFormat raw;
// Optional entries (runtime modifiable)
tagField none;
// Optional (inherited) entries
...
}
\endverbatim
Where the entries comprise:
where the entries mean:
\table
Property | Description | Required | Default value
type | Type name: particleDistribution | yes |
cloud | Name of cloud to process | Yes |
nameVsBinWidth | List of cloud field vs bin width | Yes |
tagField | Name of cloud field to use to group particles | no | none
setFormat | Output format | yes |
Property | Description | Type | Req'd | Dflt
type | Type name: particleDistribution | word | yes | -
libs | Library name: fieldFunctionObjects | word | yes | -
cloud | Name of cloud to process | word | yes | -
nameVsBinWidth | List of cloud field-bin width | wordHashTable | yes | -
setFormat | Output format | word | yes | -
tagField | Name of cloud field to use group particles | word | no | none
\endtable
The inherited entries are elaborated in:
- \link functionObject.H \endlink
- \link writeFile.H \endlink
Usage by the \c postProcess utility is not available.
See also
Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::writeFile
Foam::functionObjects::timeControl
- Foam::functionObject
- Foam::functionObjects::fvMeshFunctionObject
- Foam::functionObjects::writeFile
- ExtendedCodeGuide::functionObjects::field::particleDistribution
SourceFiles
particleDistribution.C
particleDistributionTemplates.C
\*---------------------------------------------------------------------------*/
@ -97,20 +123,20 @@ class particleDistribution
{
protected:
// Protected data
// Protected Data
//- Cloud name
word cloudName_;
//- List of field name vs. bin width
List<Tuple2<word, scalar>> nameVsBinWidth_;
//- Tag field name - used to filter the particles into groups
word tagFieldName_;
//- Random number generator - used by distribution models
Random rndGen_;
//- List of field name vs. bin width
List<Tuple2<word, scalar>> nameVsBinWidth_;
//- Writer
autoPtr<writer<scalar>> writerPtr_;
@ -135,12 +161,6 @@ protected:
const List<DynamicList<label>>& addr
);
//- No copy construct
particleDistribution(const particleDistribution&) = delete;
//- No copy assignment
void operator=(const particleDistribution&) = delete;
public:
@ -158,9 +178,15 @@ public:
const dictionary& dict
);
//- No copy construct
particleDistribution(const particleDistribution&) = delete;
//- No copy assignment
void operator=(const particleDistribution&) = delete;
//- Destructor
virtual ~particleDistribution();
virtual ~particleDistribution() = default;
// Member Functions