DOC: elaborate the usage of function objects

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

View File

@ -46,7 +46,7 @@ runTimeModifiable true;
functions
{
#includeFunc MachNo
#include "FOMachNo"
#includeFunc solverInfo
}

View File

@ -1,13 +1,17 @@
// -*- C++ -*-
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| \\ / O peration | Version: v1912 |
| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
// Control for external coupled simulation
externalCoupled
{
type externalCoupled;
libs (fieldFunctionObjects);
log true;
executeControl timeStep;
// Mandatory entries
type externalCoupled;
libs (fieldFunctionObjects);
// Directory to use for communication
commsDir "<case>/comms";
@ -34,6 +38,24 @@ externalCoupled
// Enabled or not?
#sinclude "<case>/externalCoupled.control"
// Optional entries
waitInterval 1;
// timeOut 100;
statusDone done; // Any arbitrary status=... value
calcFrequency 1;
// Optional (inherited) entries
region region0;
enabled true;
log true;
executeControl timeStep;
/*timeStart 0;
timeEnd 1000;
executeControl timeStep;
executeInterval 1;
writeControl timeStep;
writeInterval 1;*/
}

View File

@ -1,19 +1,30 @@
// -*- C++ -*-
// ************************************************************************* //
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| \\ / O peration | Version: v1912 |
| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
// Create additional volume fields (for sampling)
derivedFields
{
type derivedFields;
libs (fieldFunctionObjects);
log true;
// Mandatory entries
type derivedFields;
libs (fieldFunctionObjects);
derived (rhoU pTotal);
writeControl none;
// Optional (inherited) entries
region region0;
enabled true;
log true;
timeStart 0;
timeEnd 10000;
executeControl timeStep;
executeInterval 1;
derived (rhoU pTotal);
writeControl none;
writeInterval -1;
}
// ************************************************************************* //

View File

@ -1,28 +1,43 @@
// -*- C++ -*-
//
// Summary of fluxes
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| \\ / O peration | Version: v1912 |
| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
flux
{
// Mandatory entries
type fluxSummary;
libs (fieldFunctionObjects);
log on;
enabled true;
executeControl none;
writeControl timeStep;
writeInterval 4;
mode functionObjectSurface;
phi rhoU;
surfaces
(
sampled.plane-0.25
sampled.plane-0.45
sampled.plane-0.55
);
// Optional entries
phi rhoU;
scaleFactor 1.0;
tolerance 0.8;
// Optional (inherited) entries
writePrecision 10;
writeToFile true;
useUserTime false;
region region0;
enabled true;
log true;
timeStart 0;
timeEnd 1000000;
executeControl none;
executeInterval -1;
writeControl timeStep;
writeInterval 4;
}

View File

@ -47,13 +47,15 @@ graphFormat raw;
runTimeModifiable true;
functions
{
#include "derivedFields"
#include "sampling"
// #include "samplingDebug"
// #include "sampleCellCentres"
#include "isentropicTotalPressure"
#include "isentropicTotalPressure"
#include "wallHeatFlux"
}

View File

@ -1,21 +1,33 @@
// -*- C++ -*-
// ************************************************************************* //
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| \\ / O peration | Version: v1912 |
| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
// Create additional volume fields (for sampling)
derivedFields
{
type derivedFields;
libs (fieldFunctionObjects);
log true;
// Mandatory entries
type derivedFields;
libs (fieldFunctionObjects);
derived (rhoU pTotal);
writeControl none;
// Optional entries
rhoRef 1.25;
// Optional (inherited) entries
region region0;
enabled true;
log true;
timeStart 0;
timeEnd 10000;
executeControl timeStep;
executeInterval 1;
derived (rhoU pTotal);
rhoRef 1.25;
writeControl none;
writeInterval -1;
}
// ************************************************************************* //

View File

@ -0,0 +1,36 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| \\ / O peration | Version: v1912 |
| \\ / A nd | Website: www.openfoam.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
wallHeatFlux1
{
// Mandatory entries
type wallHeatFlux;
libs (fieldFunctionObjects);
// Optional entries
patches (walls);
qr qr;
// Optional (inherited) entries
writePrecision 10;
writeToFile true;
useUserTime true;
region region0;
enabled true;
log true;
timeStart 0;
timeEnd 1000;
executeControl timeStep;
executeInterval 1;
writeControl writeTime;
writeInterval -1;
}
// ************************************************************************* //