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

Documentation: Centred the Class Declaration comment

Browse Source 
Patch contributed by Institute of Fluid Dynamics,
Helmholtz-Zentrum Dresden - Rossendorf (HZDR)
This commit is contained in:
Henry Weller
2020-08-28 13:28:58 +01:00
parent 73e1fabc77
commit def4772281
1844 changed files with 3126 additions and 3126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -51,7 +51,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class Lambda2 Declaration
Class Lambda2 Declaration
\*---------------------------------------------------------------------------*/
class Lambda2

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -49,7 +49,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class MachNo Declaration
Class MachNo Declaration
\*---------------------------------------------------------------------------*/
class MachNo

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -54,7 +54,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class Q Declaration
Class Q Declaration
\*---------------------------------------------------------------------------*/
class Q

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -65,7 +65,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class add Declaration
Class add Declaration
\*---------------------------------------------------------------------------*/
class add

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

@ -83,7 +83,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class age Declaration
Class age Declaration
\*---------------------------------------------------------------------------*/
class age

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -51,7 +51,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class blendingFactor Declaration
Class blendingFactor Declaration
\*---------------------------------------------------------------------------*/
class blendingFactor

4
src/functionObjects/field/comfort/comfort.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2019-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -84,7 +84,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class comfort Declaration
Class comfort Declaration
\*---------------------------------------------------------------------------*/
class comfort

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -51,7 +51,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class components Declaration
Class components Declaration
\*---------------------------------------------------------------------------*/
class components

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2017-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -51,7 +51,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class ddt Declaration
Class ddt Declaration
\*---------------------------------------------------------------------------*/
class ddt

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -50,7 +50,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class div Declaration
Class div Declaration
\*---------------------------------------------------------------------------*/
class div

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2012-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -48,7 +48,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class fieldExpression Declaration
Class fieldExpression Declaration
\*---------------------------------------------------------------------------*/
class fieldExpression

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -85,7 +85,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class fieldMinMax Declaration
Class fieldMinMax Declaration
\*---------------------------------------------------------------------------*/
class fieldMinMax

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -57,7 +57,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class fieldValue Declaration
Class fieldValue Declaration
\*---------------------------------------------------------------------------*/
class fieldValue

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -179,7 +179,7 @@ namespace fieldValues
{
/*---------------------------------------------------------------------------*\
Class surfaceFieldValue Declaration
Class surfaceFieldValue Declaration
\*---------------------------------------------------------------------------*/
class surfaceFieldValue

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

@ -118,7 +118,7 @@ namespace fieldValues
{
/*---------------------------------------------------------------------------*\
Class volFieldValue Declaration
Class volFieldValue Declaration
\*---------------------------------------------------------------------------*/
class volFieldValue

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2012-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -48,7 +48,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class fieldsExpression Declaration
Class fieldsExpression Declaration
\*---------------------------------------------------------------------------*/
class fieldsExpression

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -51,7 +51,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class grad Declaration
Class grad Declaration
\*---------------------------------------------------------------------------*/
class grad

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -79,7 +79,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class histogram Declaration
Class histogram Declaration
\*---------------------------------------------------------------------------*/
class histogram

4
src/functionObjects/field/interfaceHeight/interfaceHeight.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2017-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -72,7 +72,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class interfaceHeight Declaration
Class interfaceHeight Declaration
\*---------------------------------------------------------------------------*/
class interfaceHeight

4
src/functionObjects/field/log/log.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2018-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2018-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -78,7 +78,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class log Declaration
Class log Declaration
\*---------------------------------------------------------------------------*/
class log

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2012-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -51,7 +51,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class mag Declaration
Class mag Declaration
\*---------------------------------------------------------------------------*/
class mag

2
src/functionObjects/field/nearWallFields/findCellParticle.H
View File

@ -55,7 +55,7 @@ Ostream& operator<<(Ostream&, const findCellParticle&);
/*---------------------------------------------------------------------------*\
Class findCellParticle Declaration
Class findCellParticle Declaration
\*---------------------------------------------------------------------------*/
class findCellParticle

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2012-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -125,7 +125,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class pressure Declaration
Class pressure Declaration
\*---------------------------------------------------------------------------*/
class pressure

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -50,7 +50,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class randomise Declaration
Class randomise Declaration
\*---------------------------------------------------------------------------*/
class randomise

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2018-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2018-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -51,7 +51,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class scale Declaration
Class scale Declaration
\*---------------------------------------------------------------------------*/
class scale

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

@ -51,7 +51,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class shearStress Declaration
Class shearStress Declaration
\*---------------------------------------------------------------------------*/
class shearStress

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -52,7 +52,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class streamFunction Declaration
Class streamFunction Declaration
\*---------------------------------------------------------------------------*/
class streamFunction

2
src/functionObjects/field/streamLine/streamLineParticleCloud.H
View File

@ -44,7 +44,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class streamLineCloud Declaration
Class streamLineCloud Declaration
\*---------------------------------------------------------------------------*/
class streamLineParticleCloud

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -65,7 +65,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class subtract Declaration
Class subtract Declaration
\*---------------------------------------------------------------------------*/
class subtract

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -83,7 +83,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class surfaceInterpolate Declaration
Class surfaceInterpolate Declaration
\*---------------------------------------------------------------------------*/
class surfaceInterpolate

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

@ -51,7 +51,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class totalEnthalpy Declaration
Class totalEnthalpy Declaration
\*---------------------------------------------------------------------------*/
class totalEnthalpy

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2018-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2018-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -94,7 +94,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class turbulenceIntensity Declaration
Class turbulenceIntensity Declaration
\*---------------------------------------------------------------------------*/
class turbulenceIntensity

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -84,7 +84,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class wallHeatFlux Declaration
Class wallHeatFlux Declaration
\*---------------------------------------------------------------------------*/
class wallHeatFlux

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2017-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -94,7 +94,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class wallHeatTransferCoeff Declaration
Class wallHeatTransferCoeff Declaration
\*---------------------------------------------------------------------------*/
class wallHeatTransferCoeff

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -65,7 +65,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class writeCellCentres Declaration
Class writeCellCentres Declaration
\*---------------------------------------------------------------------------*/
class writeCellCentres

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -64,7 +64,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class writeCellVolumes Declaration
Class writeCellVolumes Declaration
\*---------------------------------------------------------------------------*/
class writeCellVolumes

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

@ -81,7 +81,7 @@ namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class yPlus Declaration
Class yPlus Declaration
\*---------------------------------------------------------------------------*/
class yPlus