zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Removed incomplete, inconsistent, confusing and un-maintained header clutter

Browse Source
This commit is contained in:
Henry Weller
2018-06-20 15:55:18 +01:00
parent dea88d883a
commit f29114bfb6
307 changed files with 216 additions and 1795 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/functionObjects/field/CourantNo/CourantNo.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::CourantNo
Group
grpFieldFunctionObjects
Description
Calculates and outputs the Courant number as a volScalarField. The field is
stored on the mesh database so that it can be retrieved and used for other

5
src/functionObjects/field/Lambda2/Lambda2.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::Lambda2
Group
grpFieldFunctionObjects
Description
Calculates and outputs the second largest eigenvalue of the sum of the
square of the symmetrical and anti-symmetrical parts of the velocity

5
src/functionObjects/field/MachNo/MachNo.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::MachNo
Group
grpFieldFunctionObjects
Description
Calculates and writes the Mach number as a volScalarField.

5
src/functionObjects/field/PecletNo/PecletNo.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::PecletNo
Group
grpFieldFunctionObjects
Description
Calculates and outputs the Peclet number as a surfaceScalarField.

5
src/functionObjects/field/Q/Q.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::Q
Group
grpFieldFunctionObjects
Description
Calculates and outputs the second invariant of the velocity gradient tensor
[1/s^2].

5
src/functionObjects/field/XiReactionRate/XiReactionRate.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::XiReactionRate
Group
grpFieldFunctionObjects
Description
Writes the turbulent flame-speed and reaction-rate volScalarFields for the
Xi-based combustion models.

5
src/functionObjects/field/add/add.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::add
Group
grpFieldFunctionObjects
Description
Add a list of fields.

5
src/functionObjects/field/blendingFactor/blendingFactor.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::blendingFactor
Group
grpFieldFunctionObjects
Description
Calculates and outputs the blendingFactor as used by the bended convection
schemes. The output is a volume field (cells) whose value is calculated via

5
src/functionObjects/field/components/components.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::components
Group
grpFieldFunctionObjects
Description
Calculates the components of a field.

5
src/functionObjects/field/ddt/ddt.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2017 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2017-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::ddt
Group
grpFieldFunctionObjects
Description
Calculates the Eulerian time derivative of a field.

5
src/functionObjects/field/div/div.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::div
Group
grpFieldFunctionObjects
Description
Calculates the divergence of a field. The operation is limited to
surfaceScalarFields and volVectorFields, and the output is a volScalarField.

33
src/functionObjects/field/doc/fieldFunctionObjectsDoc.H
View File

@ -1,33 +0,0 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2018 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/>.
\defgroup grpFieldFunctionObjects Field function objects
@{
\ingroup grpFunctionObjects
This group contains field-based function objects
Function objects in this group are packaged into the
libfieldFunctionObjects.so library.
@}
\*---------------------------------------------------------------------------*/

5
src/functionObjects/field/enstrophy/enstrophy.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::enstrophy
Group
grpFieldFunctionObjects
Description
Calculates the enstrophy of the velocity.

3
src/functionObjects/field/fieldAverage/fieldAverage.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::fieldAverage
Group
grpFieldFunctionObjects
Description
Calculates average quantities for a user-specified selection of volumetric
and surface fields.

5
src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::fieldCoordinateSystemTransform
Group
grpFieldFunctionObjects
Description
Transforms a user-specified selection of fields from global Cartesian
co-ordinates to a local co-ordinate system. The fields are run-time

5
src/functionObjects/field/fieldExpression/fieldExpression.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::fieldExpression
Group
grpFieldFunctionObjects
Description
See also

5
src/functionObjects/field/fieldMinMax/fieldMinMax.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::fieldMinMax
Group
grpFieldFunctionObjects
Description
Calculates the value and location of scalar minimum and maximum for a list
of user-specified fields.

3
src/functionObjects/field/fieldValues/fieldValue/fieldValue.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::fieldValue
Group
grpFieldFunctionObjects
Description
Base class for field value -based function objects.

5
src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::fieldValues::fieldValueDelta
Group
grpFieldFunctionObjects
Description
Provides a differencing option between two 'field value' function objects.

5
src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::fieldValues::surfaceFieldValue
Group
grpFieldFunctionObjects
Description
Provides a 'face regionType' variant of the fieldValues function object.

5
src/functionObjects/field/fieldValues/volFieldValue/volFieldValue.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::fieldValues::volFieldValue
Group
grpFieldFunctionObjects
Description
Provides a 'volRegion' specialization of the fieldValue function object.

5
src/functionObjects/field/fieldsExpression/fieldsExpression.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::fieldsExpression
Group
grpFieldFunctionObjects
Description
See also

5
src/functionObjects/field/flowType/flowType.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::flowType
Group
grpFieldFunctionObjects
Description
Calculates and writes the flowType of a velocity field.

5
src/functionObjects/field/grad/grad.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::grad
Group
grpFieldFunctionObjects
Description
Calculates the gradient of a field.

3
src/functionObjects/field/histogram/histogram.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::histogram
Group
grpFieldFunctionObjects
Description
Write the volume-weighted histogram of a volScalarField.

5
src/functionObjects/field/mag/mag.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::mag
Group
grpFieldFunctionObjects
Description
Calculates the magnitude of a field.

5
src/functionObjects/field/magSqr/magSqr.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::magSqr
Group
grpFieldFunctionObjects
Description
Calculates the magnitude of the sqr of a field.

3
src/functionObjects/field/nearWallFields/nearWallFields.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::nearWallFields
Group
grpFieldFunctionObjects
Description
Samples near-patch volume fields.

5
src/functionObjects/field/pressure/pressure.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::pressure
Group
grpFieldFunctionObjects
Description
Includes tools to manipulate the pressure into different forms.

5
src/functionObjects/field/processorField/processorField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::processorField
Group
grpFieldFunctionObjects
Description
Writes a scalar field whose value is the local processor ID. The output
field name is 'processorID'.

5
src/functionObjects/field/randomise/randomise.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::randomise
Group
grpFieldFunctionObjects
Description
Adds a random component to a field, with a specified perturbation magnitude.

5
src/functionObjects/field/readFields/readFields.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::readFields
Group
grpFieldFunctionObjects
Description
Reads fields from the time directories and adds them to the mesh database
for further post-processing.

3
src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::regionSizeDistribution
Group
grpFieldFunctionObjects
Description
Creates a size distribution via interrogating a continuous phase fraction
field.

3
src/functionObjects/field/scale/scale.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::scale
Group
grpFieldFunctionObjects
Description
Multiplies a field by a scaling factor.

5
src/functionObjects/field/streamFunction/streamFunction.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::streamFunction
Group
grpFieldFunctionObjects
Description
This function object calculates and outputs the stream-function as a
pointScalarField.

3
src/functionObjects/field/streamLine/streamLine.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::streamLine
Group
grpFieldFunctionObjects
Description
Generates streamline data by sampling a set of user-specified fields along a
particle track, transported by a user-specified velocity field.

5
src/functionObjects/field/subtract/subtract.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::subtract
Group
grpFieldFunctionObjects
Description
From the first field subtract the remaining fields in the list.

2
src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H
View File

@ -24,8 +24,6 @@ License
Class
Foam::functionObjects::surfaceInterpolate
Group grpFieldFunctionObjects
Description
Linearly interpolates volume fields to generate surface fields.

5
src/functionObjects/field/turbulenceFields/turbulenceFields.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::turbulenceFields
Group
grpFieldFunctionObjects
Description
Stores turbulence fields on the mesh database for further manipulation.

3
src/functionObjects/field/turbulenceIntensity/turbulenceIntensity.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::turbulenceIntensity
Group
grpFieldFunctionObjects
Description
Evaluates and writes the turbulence intensity field 'I'.

5
src/functionObjects/field/vorticity/vorticity.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2014-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2014-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::vorticity
Group
grpFieldFunctionObjects
Description
Calculates the vorticity, the curl of the velocity.

5
src/functionObjects/field/wallHeatFlux/wallHeatFlux.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016-2017 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::wallHeatFlux
Group
grpFieldFunctionObjects
Description
Calculates and write the heat-flux at wall patches as the
volScalarField field 'wallHeatFlux'.

5
src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeff.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2017 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2017-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::wallHeatTransferCoeff
Group
grpFieldFunctionObjects
Description
Calculates and write the estimated incompressible flow heat transfer
coefficient at wall patches as the volScalarField field

3
src/functionObjects/field/wallShearStress/wallShearStress.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::wallShearStress
Group
grpForcesFunctionObjects
Description
Calculates and write the shear-stress at wall patches as
the volVectorField field 'wallShearStress'.

5
src/functionObjects/field/writeCellCentres/writeCellCentres.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::writeCellCentres
Group
grpFieldFunctionObjects
Description
Writes the cell-centres volVectorField and the three component fields as
volScalarFields.

5
src/functionObjects/field/writeCellVolumes/writeCellVolumes.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::writeCellVolumes
Group
grpFieldFunctionObjects
Description
Writes the cell-volumes volScalarField.

5
src/functionObjects/field/yPlus/yPlus.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::yPlus
Group
grpFieldFunctionObjects
Description
Evaluates and outputs turbulence y+ for models. Values written to
time directories as field 'yPlus'.

3
src/functionObjects/forces/forceCoeffs/forceCoeffs.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::forceCoeffs
Group
grpForcesFunctionObjects
Description
Extends the forces functionObject by providing lift, drag and moment
coefficients. The data can optionally be output into bins, defined in a

3
src/functionObjects/forces/forces/forces.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::forces
Group
grpForcesFunctionObjects
Description
Calculates the forces and moments by integrating the pressure and
skin-friction forces over a given list of patches.

33
src/functionObjects/forces/forcesFunctionObjectsDoc.H
View File

@ -1,33 +0,0 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2018 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/>.
\defgroup grpForcesFunctionObjects Forces function objects
@{
\ingroup grpFunctionObjects
This group contains force-based function objects
Function objects in this group are packaged into the
libforcesFunctionObjects.so library.
@}
\*---------------------------------------------------------------------------*/

5
src/functionObjects/lagrangian/cloudInfo/cloudInfo.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::cloudInfo
Group
grpLagrangianFunctionObjects
Description
Outputs Lagrangian cloud information to a file.

5
src/functionObjects/lagrangian/dsmcFields/dsmcFields.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::dsmcFields
Group
grpLagrangianFunctionObjects
Description
Calculate intensive fields:
- UMean

3
src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::icoUncoupledKinematicCloud
Group
grpLagrangianFunctionObjects
Description
This functionObject tracks a uncoupled kinematic particle cloud in the
specified velocity field of an incompressible flow (laminar, RANS or LES).

33
src/functionObjects/lagrangian/lagrangianFunctionObjectsDoc.H
View File

@ -1,33 +0,0 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2018 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/>.
\defgroup grpLagrangianFunctionObjects Lagrangian function objects
@{
\ingroup grpFunctionObjects
This group contains lagrangian-based function objects.
Function objects in this group are packaged into the
liblagrangianFunctionObjects.so library.
@}
\*---------------------------------------------------------------------------*/

5
src/functionObjects/solvers/scalarTransport/scalarTransport.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2017 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::scalarTransport
Group
grpSolversFunctionObjects
Description
Evolves a passive scalar transport equation.

5
src/functionObjects/utilities/abort/abort.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::abort
Group
grpUtilitiesFunctionObjects
Description
Watches for presence of the named file in the $FOAM_CASE directory
and aborts the calculation if it is present.

5
src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::codedFunctionObject
Group
grpUtilitiesFunctionObjects
Description
Provides a general interface to enable dynamic code compilation.

30
src/functionObjects/utilities/doc/utilitiesFunctionObjectsDoc.H
View File

@ -1,30 +0,0 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2018 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/>.
\defgroup grpUtilitiesFunctionObjects Utility function objects
@{
\ingroup grpFunctionObjects
This group contains utility-based function objects
@}
\*---------------------------------------------------------------------------*/

5
src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::removeRegisteredObject
Group
grpUtilitiesFunctionObjects
Description
Removes registered objects if present in the database.

5
src/functionObjects/utilities/residuals/residuals.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2015-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::residuals
Group
grpUtilitiesFunctionObjects
Description
Writes out the initial residual for specified fields.

3
src/functionObjects/utilities/setTimeStep/setTimeStepFunctionObject.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::setTimeStepFunctionObject
Group
grpUtilitiesFunctionObjects
Description
Overrides the timeStep. Can only be used with
solvers with adjustTimeStep control (e.g. pimpleFoam). Makes no attempt

5
src/functionObjects/utilities/systemCall/systemCall.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::systemCall
Group
grpUtilitiesFunctionObjects
Description
Executes system calls, entered in the form of a string lists.

3
src/functionObjects/utilities/time/timeFunctionObject.H
View File

@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::time
Group
grpUtilitiesFunctionObjects
Description
Writes run time, CPU time and clock time
and optionally the CPU and clock times per time step.

5
src/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::timeActivatedFileUpdate
Group
grpUtilitiesFunctionObjects
Description
Performs a file copy/replacement once a specified time has been reached.

5
src/functionObjects/utilities/writeDictionary/writeDictionary.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::writeDictionary
Group
grpUtilitiesFunctionObjects
Description
Writes dictionaries on start-up and on change.

5
src/functionObjects/utilities/writeObjects/writeObjects.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,9 +24,6 @@ License
Class
Foam::functionObjects::writeObjects
Group
grpUtilitiesFunctionObjects
Description
Allows specification of different writing frequency of objects registered
to the database.