From 6a53ed41ba02a7ab2fda50c810946808cf2571ec Mon Sep 17 00:00:00 2001 From: Henry Weller <http://cfd.direct> Date: Fri, 17 Jun 2016 17:31:34 +0100 Subject: [PATCH] Doxygen documentation: Standardized the 'See also' heading --- ...alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField.H | 4 ++-- ...phatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H | 2 +- .../alphatWallBoilingWallFunctionFvPatchScalarField.H | 4 ++-- .../copiedFixedValue/copiedFixedValueFvPatchScalarField.H | 4 ++-- .../fixedMultiPhaseHeatFluxFvPatchScalarField.H | 4 ++-- applications/test/FixedList/Test-FixedList.C | 4 ++-- applications/test/List/Test-List.C | 2 +- .../utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C | 2 +- .../foamHelp/helpTypes/helpBoundary/helpBoundary.H | 4 ++-- .../helpTypes/helpFunctionObject/helpFunctionObject.H | 4 ++-- .../dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H | 2 +- applications/utilities/postProcessing/noise/noise.C | 2 +- .../createExternalCoupledPatchGeometry.C | 4 ++-- bin/foamExec | 2 +- bin/tools/doxyFilter.sed | 4 ++-- etc/config.csh/example/prefs.csh | 2 +- etc/config.sh/example/prefs.sh | 2 +- src/ODE/ODESolvers/RKDP45/RKDP45.H | 4 ++-- src/OSspecific/POSIX/cpuTime/cpuTime.H | 4 ++-- src/OSspecific/POSIX/regExp.H | 4 ++-- src/OSspecific/POSIX/signals/sigInt.H | 4 ++-- src/OSspecific/POSIX/signals/sigQuit.H | 4 ++-- src/OSspecific/POSIX/signals/sigSegv.H | 4 ++-- .../containers/Dictionaries/DictionaryBase/DictionaryBase.H | 2 +- src/OpenFOAM/containers/HashTables/Map/Map.H | 2 +- src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H | 2 +- src/OpenFOAM/containers/Lists/IndirectList/IndirectList.H | 2 +- src/OpenFOAM/containers/Lists/PackedList/PackedBoolList.H | 2 +- src/OpenFOAM/containers/Lists/PackedList/PackedList.H | 2 +- .../db/dictionary/functionEntries/includeEntry/includeEntry.H | 2 +- .../functionEntries/includeEtcEntry/includeEtcEntry.H | 2 +- .../functionEntries/includeFuncEntry/includeFuncEntry.H | 2 +- .../includeIfPresentEntry/includeIfPresentEntry.H | 4 ++-- .../db/functionObjects/functionObject/functionObject.H | 2 +- .../functionObjects/functionObjectList/functionObjectList.H | 2 +- .../regionFunctionObject/regionFunctionObject.H | 2 +- src/OpenFOAM/db/functionObjects/writeFile/writeFile.H | 2 +- src/OpenFOAM/db/functionObjects/writeFiles/writeFiles.H | 2 +- .../derived/codedFixedValue/codedFixedValuePointPatchField.H | 2 +- .../timeVaryingUniformFixedValuePointPatchField.H | 2 +- .../preconditioners/GAMGPreconditioner/GAMGPreconditioner.H | 4 ++-- src/OpenFOAM/memory/Xfer/Xfer.H | 4 ++-- src/OpenFOAM/memory/refCount/refCount.H | 2 +- src/OpenFOAM/memory/tmp/tmp.H | 2 +- src/OpenFOAM/memory/tmpNrc/tmpNrc.H | 2 +- .../meshes/meshShapes/cellMatcher/degenerateMatcher.H | 2 +- src/OpenFOAM/meshes/meshShapes/cellMatcher/hexMatcher.H | 2 +- src/OpenFOAM/meshes/meshShapes/cellMatcher/prismMatcher.H | 2 +- src/OpenFOAM/meshes/meshShapes/cellMatcher/pyrMatcher.H | 2 +- src/OpenFOAM/meshes/meshShapes/cellMatcher/tetMatcher.H | 2 +- src/OpenFOAM/meshes/meshShapes/cellMatcher/tetWedgeMatcher.H | 2 +- src/OpenFOAM/meshes/meshShapes/cellMatcher/wedgeMatcher.H | 2 +- src/OpenFOAM/meshes/meshShapes/face/face.H | 2 +- src/OpenFOAM/meshes/meshShapes/triFace/triFace.H | 2 +- src/OpenFOAM/meshes/pointMesh/pointMeshMapper/MapPointField.H | 4 ++-- .../pointPatches/constraint/symmetry/symmetryPointPatch.H | 4 ++-- src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H | 2 +- .../polyPatches/constraint/symmetry/symmetryPolyPatch.H | 4 ++-- src/OpenFOAM/primitives/MatrixSpace/MatrixSpace.H | 2 +- src/OpenFOAM/primitives/Pair/Pair.H | 4 ++-- src/OpenFOAM/primitives/Tensor/Tensor.H | 2 +- src/OpenFOAM/primitives/Tuple2/Tuple2.H | 4 ++-- src/OpenFOAM/primitives/chars/wchar/wchar.H | 4 ++-- .../primitives/functions/Polynomial/polynomialFunction.H | 4 ++-- src/OpenFOAM/primitives/hashes/Hasher/Hasher.H | 4 ++-- src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H | 4 ++-- src/OpenFOAM/primitives/hashes/SHA1/SHA1.H | 4 ++-- src/OpenFOAM/primitives/hashes/SHA1/SHA1Digest.H | 4 ++-- .../CompactSpatialTensor/CompactSpatialTensor.H | 2 +- .../CompactSpatialTensorT/CompactSpatialTensorT.H | 2 +- .../spatialVectorAlgebra/SpatialTensor/SpatialTensor.H | 2 +- .../spatialVectorAlgebra/SpatialVector/SpatialVector.H | 2 +- src/OpenFOAM/primitives/strings/string/string.H | 4 ++-- src/OpenFOAM/primitives/triad/triad.H | 2 +- .../compressible/RAS/buoyantKEpsilon/buoyantKEpsilon.H | 2 +- .../convectiveHeatTransferFvPatchScalarField.H | 2 +- .../externalCoupledTemperatureMixedFvPatchScalarField.H | 2 +- .../externalWallHeatFluxTemperatureFvPatchScalarField.H | 2 +- .../turbulentHeatFluxTemperatureFvPatchScalarField.H | 2 +- ...turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H | 2 +- .../turbulentTemperatureRadCoupledMixedFvPatchScalarField.H | 2 +- .../alphatJayatillekeWallFunctionFvPatchScalarField.H | 2 +- .../alphatPhaseChangeWallFunctionFvPatchScalarField.H | 4 ++-- .../alphatWallFunction/alphatWallFunctionFvPatchScalarField.H | 2 +- .../turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H | 4 ++-- .../alphatJayatillekeWallFunctionFvPatchScalarField.H | 2 +- .../turbulenceModels/LES/Smagorinsky/Smagorinsky.H | 2 +- src/TurbulenceModels/turbulenceModels/LES/WALE/WALE.H | 2 +- .../turbulenceModels/LES/kOmegaSSTDES/kOmegaSSTDES.H | 2 +- .../atmBoundaryLayerInletEpsilonFvPatchScalarField.H | 4 ++-- .../atmBoundaryLayerInletKFvPatchScalarField.H | 4 ++-- .../atmBoundaryLayerInletVelocityFvPatchVectorField.H | 4 ++-- ...bulentMixingLengthDissipationRateInletFvPatchScalarField.H | 2 +- .../turbulentMixingLengthFrequencyInletFvPatchScalarField.H | 2 +- .../turbulenceModels/RAS/kOmegaSST/kOmegaSST.H | 2 +- src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.H | 2 +- src/TurbulenceModels/turbulenceModels/RAS/v2f/v2fBase.H | 4 ++-- .../epsilonLowReWallFunctionFvPatchScalarField.H | 2 +- .../epsilonWallFunctionFvPatchScalarField.H | 2 +- .../fWallFunction/fWallFunctionFvPatchScalarField.H | 2 +- .../kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H | 2 +- .../kqRWallFunction/kqRWallFunctionFvPatchField.H | 2 +- .../nutLowReWallFunctionFvPatchScalarField.H | 2 +- .../nutURoughWallFunctionFvPatchScalarField.H | 2 +- .../nutUSpaldingWallFunctionFvPatchScalarField.H | 2 +- .../nutUTabulatedWallFunctionFvPatchScalarField.H | 2 +- .../nutUWallFunction/nutUWallFunctionFvPatchScalarField.H | 2 +- .../nutWallFunction/nutWallFunctionFvPatchScalarField.H | 2 +- .../nutkAtmRoughWallFunctionFvPatchScalarField.H | 2 +- .../nutkRoughWallFunctionFvPatchScalarField.H | 2 +- .../nutkWallFunction/nutkWallFunctionFvPatchScalarField.H | 2 +- .../v2WallFunction/v2WallFunctionFvPatchScalarField.H | 2 +- .../solidBodyMotionFvMesh/solidBodyMotionFunctions/SDA/SDA.H | 4 ++-- src/edgeMesh/edgeMeshFormats/starcd/STARCDedgeFormat.H | 4 ++-- src/edgeMesh/featureEdgeMesh/featureEdgeMesh.H | 4 ++-- .../SRFFreestreamVelocityFvPatchVectorField.H | 2 +- .../SRFVelocityFvPatchVectorField.H | 2 +- .../SRFWallVelocityFvPatchVectorField.H | 2 +- .../fields/fvPatchFields/basic/mixed/mixedFvPatchField.H | 2 +- .../fields/fvPatchFields/basic/sliced/slicedFvPatchField.H | 2 +- .../constraint/cyclicACMI/cyclicACMIFvPatchField.H | 2 +- .../constraint/cyclicAMI/cyclicAMIFvPatchField.H | 2 +- .../constraint/cyclicSlip/cyclicSlipFvPatchField.H | 2 +- .../constraint/jumpCyclic/jumpCyclicFvPatchField.H | 2 +- .../constraint/jumpCyclicAMI/jumpCyclicAMIFvPatchField.H | 2 +- .../constraint/processorCyclic/processorCyclicFvPatchField.H | 2 +- .../fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H | 2 +- .../activeBaffleVelocityFvPatchVectorField.H | 2 +- .../derived/codedFixedValue/codedFixedValueFvPatchField.H | 2 +- .../fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H | 2 +- .../cylindricalInletVelocityFvPatchVectorField.H | 2 +- .../externalCoupledMixed/externalCoupledMixedFvPatchField.H | 2 +- .../fields/fvPatchFields/derived/fan/fanFvPatchField.H | 2 +- .../derived/fanPressure/fanPressureFvPatchScalarField.H | 2 +- .../fixedFluxExtrapolatedPressureFvPatchScalarField.H | 2 +- .../fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H | 2 +- .../fixedInternalValueFvPatchField.H | 2 +- .../fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H | 2 +- .../derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H | 2 +- .../fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H | 2 +- .../derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H | 2 +- .../fixedPressureCompressibleDensityFvPatchScalarField.H | 2 +- .../derived/fixedProfile/fixedProfileFvPatchField.H | 2 +- .../flowRateInletVelocityFvPatchVectorField.H | 2 +- .../fluxCorrectedVelocityFvPatchVectorField.H | 4 ++-- .../fvPatchFields/derived/freestream/freestreamFvPatchField.H | 2 +- .../freestreamPressure/freestreamPressureFvPatchScalarField.H | 2 +- .../derived/inletOutlet/inletOutletFvPatchField.H | 2 +- .../inletOutletTotalTemperatureFvPatchScalarField.H | 2 +- .../derived/mappedField/mappedFieldFvPatchField.H | 2 +- .../mappedFixedInternalValueFvPatchField.H | 2 +- .../mappedFixedPushedInternalValueFvPatchField.H | 2 +- .../derived/mappedFixedValue/mappedFixedValueFvPatchField.H | 2 +- .../mappedVelocityFluxFixedValueFvPatchField.H | 2 +- .../movingWallVelocity/movingWallVelocityFvPatchVectorField.H | 2 +- .../fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H | 2 +- .../derived/outletInlet/outletInletFvPatchField.H | 2 +- .../outletMappedUniformInletFvPatchField.H | 2 +- .../outletPhaseMeanVelocityFvPatchVectorField.H | 2 +- .../derived/partialSlip/partialSlipFvPatchField.H | 2 +- .../phaseHydrostaticPressureFvPatchScalarField.H | 2 +- .../pressureDirectedInletOutletVelocityFvPatchVectorField.H | 2 +- .../pressureDirectedInletVelocityFvPatchVectorField.H | 2 +- .../pressureInletOutletParSlipVelocityFvPatchVectorField.H | 2 +- .../pressureInletVelocityFvPatchVectorField.H | 2 +- .../pressureNormalInletOutletVelocityFvPatchVectorField.H | 2 +- .../derived/prghPressure/prghPressureFvPatchScalarField.H | 2 +- .../prghTotalHydrostaticPressureFvPatchScalarField.H | 2 +- .../prghTotalPressure/prghTotalPressureFvPatchScalarField.H | 2 +- .../rotatingPressureInletOutletVelocityFvPatchVectorField.H | 2 +- .../rotatingTotalPressureFvPatchScalarField.H | 2 +- .../rotatingWallVelocityFvPatchVectorField.H | 2 +- .../surfaceNormalFixedValueFvPatchVectorField.H | 2 +- .../swirlFlowRateInletVelocityFvPatchVectorField.H | 2 +- .../syringePressure/syringePressureFvPatchScalarField.H | 2 +- .../timeVaryingMappedFixedValueFvPatchField.H | 2 +- .../derived/totalPressure/totalPressureFvPatchScalarField.H | 2 +- .../totalTemperature/totalTemperatureFvPatchScalarField.H | 2 +- .../translatingWallVelocityFvPatchVectorField.H | 2 +- .../derived/turbulentInlet/turbulentInletFvPatchField.H | 2 +- .../turbulentIntensityKineticEnergyInletFvPatchScalarField.H | 2 +- .../uniformFixedGradient/uniformFixedGradientFvPatchField.H | 2 +- .../derived/uniformFixedValue/uniformFixedValueFvPatchField.H | 2 +- .../uniformInletOutlet/uniformInletOutletFvPatchField.H | 2 +- .../derived/uniformJump/uniformJumpFvPatchField.H | 2 +- .../derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H | 2 +- .../uniformTotalPressureFvPatchScalarField.H | 2 +- .../variableHeightFlowRateInletVelocityFvPatchVectorField.H | 2 +- .../waveSurfacePressureFvPatchScalarField.H | 2 +- .../derived/waveTransmissive/waveTransmissiveFvPatchField.H | 2 +- .../CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H | 2 +- .../finiteVolume/ddtSchemes/SLTSDdtScheme/SLTSDdtScheme.H | 2 +- .../ddtSchemes/localEulerDdtScheme/localEulerDdtScheme.H | 2 +- .../gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H | 2 +- .../gradSchemes/LeastSquaresGrad/LeastSquaresVectors.H | 2 +- .../fvMesh/fvMeshFunctionObject/fvMeshFunctionObject.H | 2 +- .../patchDistMethods/Poisson/PoissonPatchDistMethod.H | 4 ++-- .../advectionDiffusion/advectionDiffusionPatchDistMethod.H | 4 ++-- .../patchDistMethods/meshWave/meshWavePatchDistMethod.H | 4 ++-- src/finiteVolume/fvMesh/wallDist/wallDist/wallDist.H | 4 ++-- .../schemes/cellCoBlended/cellCoBlended.H | 2 +- src/functionObjects/field/CourantNo/CourantNo.H | 2 +- src/functionObjects/field/Lambda2/Lambda2.H | 2 +- src/functionObjects/field/MachNo/MachNo.H | 2 +- src/functionObjects/field/PecletNo/PecletNo.H | 2 +- src/functionObjects/field/Q/Q.H | 2 +- src/functionObjects/field/blendingFactor/blendingFactor.H | 2 +- src/functionObjects/field/components/components.H | 2 +- src/functionObjects/field/div/div.H | 2 +- src/functionObjects/field/enstrophy/enstrophy.H | 2 +- src/functionObjects/field/fieldAverage/fieldAverage.H | 2 +- .../fieldCoordinateSystemTransform.H | 2 +- src/functionObjects/field/fieldExpression/fieldExpression.H | 2 +- src/functionObjects/field/fieldMinMax/fieldMinMax.H | 2 +- .../field/fieldValues/fieldValueDelta/fieldValueDelta.H | 2 +- .../field/fieldValues/surfaceRegion/surfaceRegion.H | 2 +- src/functionObjects/field/fieldValues/volRegion/volRegion.H | 2 +- src/functionObjects/field/flowType/flowType.H | 2 +- src/functionObjects/field/grad/grad.H | 2 +- src/functionObjects/field/histogram/histogram.H | 2 +- src/functionObjects/field/mag/mag.H | 2 +- src/functionObjects/field/magSqr/magSqr.H | 2 +- src/functionObjects/field/nearWallFields/nearWallFields.H | 2 +- src/functionObjects/field/pressure/pressure.H | 2 +- src/functionObjects/field/processorField/processorField.H | 2 +- src/functionObjects/field/randomise/randomise.H | 2 +- src/functionObjects/field/readFields/readFields.H | 2 +- .../field/regionSizeDistribution/regionSizeDistribution.H | 2 +- src/functionObjects/field/streamLine/streamLine.H | 2 +- .../field/surfaceInterpolate/surfaceInterpolate.H | 2 +- src/functionObjects/field/turbulenceFields/turbulenceFields.H | 2 +- src/functionObjects/field/vorticity/vorticity.H | 2 +- .../field/wallBoundedStreamLine/wallBoundedStreamLine.H | 2 +- src/functionObjects/field/wallShearStress/wallShearStress.H | 2 +- src/functionObjects/field/yPlus/yPlus.H | 2 +- src/functionObjects/forces/forceCoeffs/forceCoeffs.H | 2 +- src/functionObjects/forces/forces/forces.H | 2 +- src/functionObjects/lagrangian/cloudInfo/cloudInfo.H | 2 +- .../icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H | 2 +- src/functionObjects/solvers/scalarTransport/scalarTransport.H | 2 +- .../utilities/codedFunctionObject/codedFunctionObject.H | 2 +- .../utilities/removeRegisteredObject/removeRegisteredObject.H | 2 +- src/functionObjects/utilities/residuals/residuals.H | 2 +- src/functionObjects/utilities/systemCall/systemCall.H | 2 +- src/functionObjects/utilities/writeObjects/writeObjects.H | 2 +- .../timeVaryingMappedFixedValuePointPatchField.H | 2 +- .../constraints/fixedValueConstraint/FixedValueConstraint.H | 2 +- .../sources/derived/rotorDiskSource/rotorDiskSource.H | 2 +- .../sources/general/semiImplicitSource/SemiImplicitSource.H | 2 +- .../genericFvPatchField/genericFvPatchField.H | 2 +- src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H | 2 +- src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H | 2 +- src/mesh/blockMesh/curvedEdges/BSpline.H | 4 ++-- src/mesh/blockMesh/curvedEdges/CatmullRomSpline.H | 4 ++-- src/mesh/extrudeModel/cyclicSector/cyclicSector.H | 4 ++-- src/mesh/extrudeModel/planeExtrusion/planeExtrusion.H | 4 ++-- src/mesh/extrudeModel/wedge/wedge.H | 4 ++-- src/meshTools/cellDist/patchWave/patchDataWave.H | 2 +- src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.H | 2 +- .../filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.H | 2 +- .../filmHeightInletVelocityFvPatchVectorField.H | 2 +- .../alphatFilmWallFunctionFvPatchScalarField.H | 2 +- .../nutkFilmWallFunctionFvPatchScalarField.H | 2 +- .../thermalBaffle/thermalBaffleFvPatchScalarField.H | 2 +- .../rigidBodySolvers/CrankNicolson/CrankNicolson.H | 2 +- .../rigidBodySolvers/symplectic/symplectic.H | 2 +- src/sampling/meshToMesh/meshToMesh.H | 2 +- .../sixDoFSolvers/CrankNicolson/CrankNicolson.H | 4 ++-- .../sixDoFSolvers/symplectic/symplectic.H | 4 ++-- src/surfMesh/UnsortedMeshedSurface/UnsortedMeshedSurface.H | 2 +- src/surfMesh/surfaceFormats/off/OFFsurfaceFormat.H | 2 +- src/surfMesh/surfaceFormats/smesh/SMESHsurfaceFormat.H | 2 +- src/surfMesh/surfaceFormats/starcd/STARCDsurfaceFormat.H | 2 +- .../energyJump/energyJump/energyJumpFvPatchScalarField.H | 2 +- .../energyJumpAMI/energyJumpAMIFvPatchScalarField.H | 2 +- .../fixedEnergy/fixedEnergyFvPatchScalarField.H | 2 +- .../gradientEnergy/gradientEnergyFvPatchScalarField.H | 2 +- .../mixedEnergy/mixedEnergyFvPatchScalarField.H | 4 ++-- .../liquidMixtureProperties/liquidMixtureProperties.H | 4 ++-- .../solidMixtureProperties/solidMixtureProperties.H | 4 ++-- .../MarshakRadiation/MarshakRadiationFvPatchScalarField.H | 2 +- .../MarshakRadiationFixedTemperatureFvPatchScalarField.H | 2 +- .../greyDiffusiveRadiationMixedFvPatchScalarField.H | 2 +- .../greyDiffusiveViewFactorFixedValueFvPatchScalarField.H | 2 +- .../wideBandDiffusiveRadiationMixedFvPatchScalarField.H | 2 +- .../functionObjects/moleFractions/moleFractions.H | 2 +- .../constantAlphaContactAngleFvPatchScalarField.H | 4 ++-- .../temperatureDependentAlphaContactAngleFvPatchScalarField.H | 2 +- 288 files changed, 343 insertions(+), 343 deletions(-) diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatFixedDmdtWallBoilingWallFunction/alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField.H b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatFixedDmdtWallBoilingWallFunction/alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField.H index 4238f774441..42b314e45bf 100755 --- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatFixedDmdtWallBoilingWallFunction/alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField.H +++ b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatFixedDmdtWallBoilingWallFunction/alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -32,7 +32,7 @@ Description A simple alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField with a fixed volumetric phase-change mass flux. -SeeAlso +See also Foam::compressible:: alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H index f7186fcf053..bdf3153c33b 100755 --- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H +++ b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H @@ -55,7 +55,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::compressible::alphatPhaseChangeWallFunctionFvPatchScalarField SourceFiles diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatWallBoilingWallFunction/alphatWallBoilingWallFunctionFvPatchScalarField.H b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatWallBoilingWallFunction/alphatWallBoilingWallFunctionFvPatchScalarField.H index c469abdae94..cfef83e443e 100755 --- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatWallBoilingWallFunction/alphatWallBoilingWallFunctionFvPatchScalarField.H +++ b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatWallBoilingWallFunction/alphatWallBoilingWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -51,7 +51,7 @@ Description Daejeon, Korea, September 10-12 2012 \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/copiedFixedValue/copiedFixedValueFvPatchScalarField.H b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/copiedFixedValue/copiedFixedValueFvPatchScalarField.H index 2db6a151ce9..b2af2f1c4a8 100644 --- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/copiedFixedValue/copiedFixedValueFvPatchScalarField.H +++ b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/copiedFixedValue/copiedFixedValueFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Group Description Copies the boundary values from a user specified field. -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/fixedMultiPhaseHeatFlux/fixedMultiPhaseHeatFluxFvPatchScalarField.H b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/fixedMultiPhaseHeatFlux/fixedMultiPhaseHeatFluxFvPatchScalarField.H index c3eb42d6913..56a7e5dbfb4 100644 --- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/fixedMultiPhaseHeatFlux/fixedMultiPhaseHeatFluxFvPatchScalarField.H +++ b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/fixedMultiPhaseHeatFlux/fixedMultiPhaseHeatFluxFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -36,7 +36,7 @@ Description - Set 'fixedMultiPhaseHeatFlux' boundary for one of the phases - Use 'copiedFixedValue' for all the other phases. -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/applications/test/FixedList/Test-FixedList.C b/applications/test/FixedList/Test-FixedList.C index 4b90ab81ab8..42c3356d823 100644 --- a/applications/test/FixedList/Test-FixedList.C +++ b/applications/test/FixedList/Test-FixedList.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Application Description Simple tests and examples of use of FixedList -See Also +See also Foam::FixedList \*---------------------------------------------------------------------------*/ diff --git a/applications/test/List/Test-List.C b/applications/test/List/Test-List.C index 3201f7a806a..5f38f3f8faa 100644 --- a/applications/test/List/Test-List.C +++ b/applications/test/List/Test-List.C @@ -27,7 +27,7 @@ Application Description Simple tests and examples of use of List -See Also +See also Foam::List \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C index b02464d0c58..0570ff62b6c 100644 --- a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C +++ b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C @@ -44,7 +44,7 @@ Note will be used if available. Otherwise the cellZones are used when creating the cellTable information. -See Also +See also Foam::cellTable, Foam::meshWriter and Foam::meshWriters::STARCD \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H index 6166e8e1f3b..a4889b353bc 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -40,7 +40,7 @@ Description Note To use the \c -fixedValue option, the \c -field option should also be used -SeeAlso +See also Foam::helpType Foam::fvPatchField diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H index 4e8276bcdb3..d0a2b712c99 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -33,7 +33,7 @@ Description \c -browse \<patch type\> | open documentation for object in browser \endplaintable -SeeAlso +See also Foam::helpType Foam::functionObject diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H index 02af8d8349f..f6934841288 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H +++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H @@ -53,7 +53,7 @@ Usage objectNames | objects to write | yes | \endtable -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::timeControl diff --git a/applications/utilities/postProcessing/noise/noise.C b/applications/utilities/postProcessing/noise/noise.C index 5e112f0550a..77e549c9de4 100644 --- a/applications/utilities/postProcessing/noise/noise.C +++ b/applications/utilities/postProcessing/noise/noise.C @@ -71,7 +71,7 @@ Usage - one-third-octave-band PFL spectrum - one-third-octave-band pressure spectrum -SeeAlso +See also CSV.H noiseFFT.H diff --git a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C index 3b9ed64abb3..469e825c6c0 100644 --- a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C +++ b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -41,7 +41,7 @@ Note: The addressing is patch-local, i.e. point indices for each patch point used for face addressing starts at index 0. -SeeAlso +See also externalCoupledMixedFvPatchField \*---------------------------------------------------------------------------*/ diff --git a/bin/foamExec b/bin/foamExec index 45a22237eac..cb6fec4bfa6 100755 --- a/bin/foamExec +++ b/bin/foamExec @@ -43,7 +43,7 @@ # # foamEtcFile must be found in the same directory as this script # -# SeeAlso +# See also # foamEtcFile # #------------------------------------------------------------------------------ diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed index 83142de17d9..a1a99ace263 100644 --- a/bin/tools/doxyFilter.sed +++ b/bin/tools/doxyFilter.sed @@ -123,8 +123,8 @@ s/^ // } -/^See *Also *$/,/^[^ ]/{ -/^See *Also/c\ +/^See *[Aa]lso *$/,/^[^ ]/{ +/^See *[Aa]lso/c\ \\see s/^ // } diff --git a/etc/config.csh/example/prefs.csh b/etc/config.csh/example/prefs.csh index 20ac1a67be0..99dca9f454d 100644 --- a/etc/config.csh/example/prefs.csh +++ b/etc/config.csh/example/prefs.csh @@ -30,7 +30,7 @@ # The prefs.csh file will be sourced by the OpenFOAM etc/cshrc when it is # found by foamEtcFile. # -# See Also +# See also # 'foamEtcFile -help' or 'foamEtcFile -list' for information about the # paths searched # diff --git a/etc/config.sh/example/prefs.sh b/etc/config.sh/example/prefs.sh index 58b1fd76614..883db4bda53 100644 --- a/etc/config.sh/example/prefs.sh +++ b/etc/config.sh/example/prefs.sh @@ -30,7 +30,7 @@ # The prefs.sh file will be sourced by the OpenFOAM etc/bashrc when it is # found by foamEtcFile. # -# See Also +# See also # 'foamEtcFile -help' or 'foamEtcFile -list' for information about the # paths searched # diff --git a/src/ODE/ODESolvers/RKDP45/RKDP45.H b/src/ODE/ODESolvers/RKDP45/RKDP45.H index b3f5c7bca4a..9998c15f6b0 100644 --- a/src/ODE/ODESolvers/RKDP45/RKDP45.H +++ b/src/ODE/ODESolvers/RKDP45/RKDP45.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -43,7 +43,7 @@ Description Springer-Verlag, Berlin. 1993, ISBN 3-540-56670-8. \endverbatim -SeeAlso +See also Foam::RKF45 Foam::RKCK45 diff --git a/src/OSspecific/POSIX/cpuTime/cpuTime.H b/src/OSspecific/POSIX/cpuTime/cpuTime.H index a283d572c67..72a37eb64c6 100644 --- a/src/OSspecific/POSIX/cpuTime/cpuTime.H +++ b/src/OSspecific/POSIX/cpuTime/cpuTime.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description Starts timing CPU usage and return elapsed time from start. -SeeAlso +See also clockTime SourceFiles diff --git a/src/OSspecific/POSIX/regExp.H b/src/OSspecific/POSIX/regExp.H index b4f4554790b..ae91c5df8b3 100644 --- a/src/OSspecific/POSIX/regExp.H +++ b/src/OSspecific/POSIX/regExp.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description The PCRE '(?i)' extension is provided to compile the regular expression as being case-insensitive. -SeeAlso +See also The manpage regex(7) for more information about POSIX regular expressions. These differ somewhat from \c Perl and \c sed regular expressions. diff --git a/src/OSspecific/POSIX/signals/sigInt.H b/src/OSspecific/POSIX/signals/sigInt.H index f079aa713c3..8a021c28660 100644 --- a/src/OSspecific/POSIX/signals/sigInt.H +++ b/src/OSspecific/POSIX/signals/sigInt.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description The standard interupt handler is overridden to ensure that the runningJob file is removed. -See Also +See also Foam::JobInfo SourceFiles diff --git a/src/OSspecific/POSIX/signals/sigQuit.H b/src/OSspecific/POSIX/signals/sigQuit.H index 8dc04993519..4bbbc1f8ee3 100644 --- a/src/OSspecific/POSIX/signals/sigQuit.H +++ b/src/OSspecific/POSIX/signals/sigQuit.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description The standard interupt handler is overridden to ensure that the runningJob file is removed. -See Also +See also Foam::JobInfo SourceFiles diff --git a/src/OSspecific/POSIX/signals/sigSegv.H b/src/OSspecific/POSIX/signals/sigSegv.H index 0cfaf05eee4..0a7d9809d71 100644 --- a/src/OSspecific/POSIX/signals/sigSegv.H +++ b/src/OSspecific/POSIX/signals/sigSegv.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description The standard interupt handler is overridden to ensure that the runningJob file is removed. -See Also +See also Foam::JobInfo SourceFiles diff --git a/src/OpenFOAM/containers/Dictionaries/DictionaryBase/DictionaryBase.H b/src/OpenFOAM/containers/Dictionaries/DictionaryBase/DictionaryBase.H index 5676dfc16d7..8ba13836efa 100644 --- a/src/OpenFOAM/containers/Dictionaries/DictionaryBase/DictionaryBase.H +++ b/src/OpenFOAM/containers/Dictionaries/DictionaryBase/DictionaryBase.H @@ -36,7 +36,7 @@ Note gcc 2.95.2 so it has to be instantiated for T when an instantiation of DictionaryBase is requested -See Also +See also Dictionary and UDictionary SourceFiles diff --git a/src/OpenFOAM/containers/HashTables/Map/Map.H b/src/OpenFOAM/containers/HashTables/Map/Map.H index f9d6082eada..46de9dbedb0 100644 --- a/src/OpenFOAM/containers/HashTables/Map/Map.H +++ b/src/OpenFOAM/containers/HashTables/Map/Map.H @@ -27,7 +27,7 @@ Class Description A HashTable to objects of type \<T\> with a label key. -See Also +See also PtrMap \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H b/src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H index 89054f95a11..134a7fa9b08 100644 --- a/src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H +++ b/src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H @@ -27,7 +27,7 @@ Class Description A HashTable of pointers to objects of type \<T\> with a label key. -See Also +See also Map, HashPtrTable \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/containers/Lists/IndirectList/IndirectList.H b/src/OpenFOAM/containers/Lists/IndirectList/IndirectList.H index 1d554d7d7e9..a320682a60e 100644 --- a/src/OpenFOAM/containers/Lists/IndirectList/IndirectList.H +++ b/src/OpenFOAM/containers/Lists/IndirectList/IndirectList.H @@ -27,7 +27,7 @@ Class Description A List with indirect addressing. -SeeAlso +See also Foam::UIndirectList for a version without any allocation for the addressing. diff --git a/src/OpenFOAM/containers/Lists/PackedList/PackedBoolList.H b/src/OpenFOAM/containers/Lists/PackedList/PackedBoolList.H index 37620f97f8e..b2ca0037f85 100644 --- a/src/OpenFOAM/containers/Lists/PackedList/PackedBoolList.H +++ b/src/OpenFOAM/containers/Lists/PackedList/PackedBoolList.H @@ -35,7 +35,7 @@ SourceFiles PackedBoolListI.H PackedBoolList.C -SeeAlso +See also Foam::PackedList \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/containers/Lists/PackedList/PackedList.H b/src/OpenFOAM/containers/Lists/PackedList/PackedList.H index 8af97000ff1..43bc8a5cdac 100644 --- a/src/OpenFOAM/containers/Lists/PackedList/PackedList.H +++ b/src/OpenFOAM/containers/Lists/PackedList/PackedList.H @@ -89,7 +89,7 @@ Note \endverbatim In both cases, the supplied indices can be randomly ordered. -SeeAlso +See also Foam::DynamicList SourceFiles diff --git a/src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.H b/src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.H index bcc9cabbfb0..b26236f77c8 100644 --- a/src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.H +++ b/src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.H @@ -36,7 +36,7 @@ Description The usual expansion of environment variables and other constructs (eg, the \c ~OpenFOAM/ expansion) is retained. -See Also +See also fileName, string::expand() SourceFiles diff --git a/src/OpenFOAM/db/dictionary/functionEntries/includeEtcEntry/includeEtcEntry.H b/src/OpenFOAM/db/dictionary/functionEntries/includeEtcEntry/includeEtcEntry.H index 6644fbec426..b58e905b5c0 100644 --- a/src/OpenFOAM/db/dictionary/functionEntries/includeEtcEntry/includeEtcEntry.H +++ b/src/OpenFOAM/db/dictionary/functionEntries/includeEtcEntry/includeEtcEntry.H @@ -51,7 +51,7 @@ Description The usual expansion of environment variables and other constructs is retained. -See Also +See also findEtcFile, fileName, string::expand() SourceFiles diff --git a/src/OpenFOAM/db/dictionary/functionEntries/includeFuncEntry/includeFuncEntry.H b/src/OpenFOAM/db/dictionary/functionEntries/includeFuncEntry/includeFuncEntry.H index c68c6d764b1..b27175a569f 100644 --- a/src/OpenFOAM/db/dictionary/functionEntries/includeFuncEntry/includeFuncEntry.H +++ b/src/OpenFOAM/db/dictionary/functionEntries/includeFuncEntry/includeFuncEntry.H @@ -55,7 +55,7 @@ Description #includeFunc mag(p) \endverbatim -See Also +See also Foam::functionObjectList SourceFiles diff --git a/src/OpenFOAM/db/dictionary/functionEntries/includeIfPresentEntry/includeIfPresentEntry.H b/src/OpenFOAM/db/dictionary/functionEntries/includeIfPresentEntry/includeIfPresentEntry.H index 173112f57a0..4c217e5d1fa 100644 --- a/src/OpenFOAM/db/dictionary/functionEntries/includeIfPresentEntry/includeIfPresentEntry.H +++ b/src/OpenFOAM/db/dictionary/functionEntries/includeIfPresentEntry/includeIfPresentEntry.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description The \c \#includeIfPresent directive is similar to the \c \#include directive, but does not generate an error if the file does not exist. -See Also +See also Foam::functionEntries::includeEntry SourceFiles diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H index 8bf20a0f281..fa407cce12e 100644 --- a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H +++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H @@ -97,7 +97,7 @@ Class Description Abstract base-class for Time/database function objects. -See Also +See also Foam::functionObjectList Foam::functionObjects::timeControl diff --git a/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H b/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H index 4bfaa70214f..83a3060d35d 100644 --- a/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H +++ b/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H @@ -28,7 +28,7 @@ Description List of function objects with start(), execute() and end() functions that is called for each object. -See Also +See also Foam::functionObject Foam::functionObjects::timeControl diff --git a/src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObject.H b/src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObject.H index 928ad04abdc..a7872e47894 100644 --- a/src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObject.H +++ b/src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObject.H @@ -28,7 +28,7 @@ Description Specialization of Foam::functionObject for a region and providing a reference to the region Foam::objectRegistry. -SeeAlso +See also Foam::functionObject SourceFiles diff --git a/src/OpenFOAM/db/functionObjects/writeFile/writeFile.H b/src/OpenFOAM/db/functionObjects/writeFile/writeFile.H index 9da9c541969..111a50a7f99 100644 --- a/src/OpenFOAM/db/functionObjects/writeFile/writeFile.H +++ b/src/OpenFOAM/db/functionObjects/writeFile/writeFile.H @@ -27,7 +27,7 @@ Class Description functionObject base class for writing single files -See Also +See also Foam::regionFunctionObject Foam::functionObject diff --git a/src/OpenFOAM/db/functionObjects/writeFiles/writeFiles.H b/src/OpenFOAM/db/functionObjects/writeFiles/writeFiles.H index 3736262fd8b..12667a11ea2 100644 --- a/src/OpenFOAM/db/functionObjects/writeFiles/writeFiles.H +++ b/src/OpenFOAM/db/functionObjects/writeFiles/writeFiles.H @@ -27,7 +27,7 @@ Class Description functionObject base class for writing files -See Also +See also Foam::functionObject Foam::OutputFilterFunctionObject diff --git a/src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H b/src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H index 23500afe51e..49e206709bb 100644 --- a/src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H +++ b/src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H @@ -71,7 +71,7 @@ Description } \endverbatim -SeeAlso +See also codedFixedValueFvPatchField SourceFiles diff --git a/src/OpenFOAM/fields/pointPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValuePointPatchField.H b/src/OpenFOAM/fields/pointPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValuePointPatchField.H index 2880afa4c41..d7d42cde1c1 100644 --- a/src/OpenFOAM/fields/pointPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValuePointPatchField.H +++ b/src/OpenFOAM/fields/pointPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValuePointPatchField.H @@ -27,7 +27,7 @@ Class Description A time-varying form of a uniform fixed value boundary condition. -See Also +See also Foam::timeVaryingUniformFixedValueFvField SourceFiles diff --git a/src/OpenFOAM/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.H b/src/OpenFOAM/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.H index f79f7f1f1fc..60980e921fa 100644 --- a/src/OpenFOAM/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.H +++ b/src/OpenFOAM/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description Geometric agglomerated algebraic multigrid preconditioner. -See Also +See also GAMGSolver for more details. SourceFiles diff --git a/src/OpenFOAM/memory/Xfer/Xfer.H b/src/OpenFOAM/memory/Xfer/Xfer.H index ecbb8ed823f..0c5e8e8cff0 100644 --- a/src/OpenFOAM/memory/Xfer/Xfer.H +++ b/src/OpenFOAM/memory/Xfer/Xfer.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -59,7 +59,7 @@ Description labelList plainLst(dynLst.xfer()); \endcode -SeeAlso +See also xferCopy, xferCopyTo, xferMove, xferMoveTo, xferTmp SourceFiles diff --git a/src/OpenFOAM/memory/refCount/refCount.H b/src/OpenFOAM/memory/refCount/refCount.H index 8eee3182f64..a4a208b3c05 100644 --- a/src/OpenFOAM/memory/refCount/refCount.H +++ b/src/OpenFOAM/memory/refCount/refCount.H @@ -27,7 +27,7 @@ Class Description Reference counter for various OpenFOAM components. -SeeAlso +See also Foam::tmp Foam::token::compound diff --git a/src/OpenFOAM/memory/tmp/tmp.H b/src/OpenFOAM/memory/tmp/tmp.H index 5448b2533e3..7aeedfd9ed1 100644 --- a/src/OpenFOAM/memory/tmp/tmp.H +++ b/src/OpenFOAM/memory/tmp/tmp.H @@ -30,7 +30,7 @@ Description SourceFiles tmpI.H -SeeAlso +See also Foam::refCount Foam::autoPtr diff --git a/src/OpenFOAM/memory/tmpNrc/tmpNrc.H b/src/OpenFOAM/memory/tmpNrc/tmpNrc.H index 8a8ae021e0d..b31ad33f437 100644 --- a/src/OpenFOAM/memory/tmpNrc/tmpNrc.H +++ b/src/OpenFOAM/memory/tmpNrc/tmpNrc.H @@ -30,7 +30,7 @@ Description SourceFiles tmpNrcI.H -SeeAlso +See also Foam::autoPtr \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/degenerateMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/degenerateMatcher.H index 4513870b64a..c91671d9caf 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/degenerateMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/degenerateMatcher.H @@ -28,7 +28,7 @@ Description Collection of all hex degenerate matchers (hex, wedge, prism etc.) Has static member function to match a shape. -See Also +See also cellMatcher SourceFiles diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/hexMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/hexMatcher.H index 3a656ce6010..5bafb985ee5 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/hexMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/hexMatcher.H @@ -27,7 +27,7 @@ Class Description A cellMatcher for hex cells -See Also +See also cellMatcher SourceFiles diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/prismMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/prismMatcher.H index 8e69686418e..afbfb220c7b 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/prismMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/prismMatcher.H @@ -27,7 +27,7 @@ Class Description A cellMatcher for prism cells -See Also +See also cellMatcher SourceFiles diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/pyrMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/pyrMatcher.H index f39ee7583e1..2c6dc1d1054 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/pyrMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/pyrMatcher.H @@ -27,7 +27,7 @@ Class Description A cellMatcher for pyr cells -See Also +See also cellMatcher SourceFiles diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetMatcher.H index d9d0c6329a3..fe5bf02e0bc 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetMatcher.H @@ -27,7 +27,7 @@ Class Description A cellMatcher for tet cells -See Also +See also cellMatcher SourceFiles diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetWedgeMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetWedgeMatcher.H index 5b4525a8ac1..cee5714db4d 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetWedgeMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetWedgeMatcher.H @@ -27,7 +27,7 @@ Class Description A cellMatcher for tetWedge cells -See Also +See also cellMatcher SourceFiles diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/wedgeMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/wedgeMatcher.H index 6d827fc2671..c4c20660ca7 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/wedgeMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/wedgeMatcher.H @@ -27,7 +27,7 @@ Class Description A cellMatcher for wedge cells -See Also +See also cellMatcher SourceFiles diff --git a/src/OpenFOAM/meshes/meshShapes/face/face.H b/src/OpenFOAM/meshes/meshShapes/face/face.H index ca5fd198aad..0504145adeb 100644 --- a/src/OpenFOAM/meshes/meshShapes/face/face.H +++ b/src/OpenFOAM/meshes/meshShapes/face/face.H @@ -27,7 +27,7 @@ Class Description A face is a list of labels corresponding to mesh vertices. -SeeAlso +See also Foam::triFace SourceFiles diff --git a/src/OpenFOAM/meshes/meshShapes/triFace/triFace.H b/src/OpenFOAM/meshes/meshShapes/triFace/triFace.H index 2a66556d223..2e7a730228a 100644 --- a/src/OpenFOAM/meshes/meshShapes/triFace/triFace.H +++ b/src/OpenFOAM/meshes/meshShapes/triFace/triFace.H @@ -28,7 +28,7 @@ Description A triangular face using a FixedList of labels corresponding to mesh vertices. -SeeAlso +See also Foam::face, Foam::triangle SourceFiles diff --git a/src/OpenFOAM/meshes/pointMesh/pointMeshMapper/MapPointField.H b/src/OpenFOAM/meshes/pointMesh/pointMeshMapper/MapPointField.H index 8248e5e09cb..d3b16d89329 100644 --- a/src/OpenFOAM/meshes/pointMesh/pointMeshMapper/MapPointField.H +++ b/src/OpenFOAM/meshes/pointMesh/pointMeshMapper/MapPointField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -28,7 +28,7 @@ Description Map point field on topology change. This is a partial template specialisation for GeoMesh=pointMesh -See Also +See also MapGeometricFields \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/meshes/pointMesh/pointPatches/constraint/symmetry/symmetryPointPatch.H b/src/OpenFOAM/meshes/pointMesh/pointPatches/constraint/symmetry/symmetryPointPatch.H index 35cf991cb96..04f2180e00a 100644 --- a/src/OpenFOAM/meshes/pointMesh/pointPatches/constraint/symmetry/symmetryPointPatch.H +++ b/src/OpenFOAM/meshes/pointMesh/pointPatches/constraint/symmetry/symmetryPointPatch.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description SourceFiles symmetryPointPatch.C -SeeAlso +See also symmetryPlanePointPatch \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H b/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H index 2362f9382f6..8e94ec82fb9 100644 --- a/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H +++ b/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H @@ -68,7 +68,7 @@ Note of shared edges. Doing full analysis of how many patches use the edge would be too complicated -SeeAlso +See also mapDistribute globalIndexAndTransform diff --git a/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/symmetry/symmetryPolyPatch.H b/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/symmetry/symmetryPolyPatch.H index c07f46eb69e..6f52684f7be 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/symmetry/symmetryPolyPatch.H +++ b/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/symmetry/symmetryPolyPatch.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description SourceFiles symmetryPolyPatch.C -SeeAlso +See also symmetryPlanePolyPatch \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/primitives/MatrixSpace/MatrixSpace.H b/src/OpenFOAM/primitives/MatrixSpace/MatrixSpace.H index f04f302f57c..f06874fac7e 100644 --- a/src/OpenFOAM/primitives/MatrixSpace/MatrixSpace.H +++ b/src/OpenFOAM/primitives/MatrixSpace/MatrixSpace.H @@ -33,7 +33,7 @@ Description SourceFiles MatrixSpaceI.H -SeeAlso +See also Foam::VectorSpace \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/primitives/Pair/Pair.H b/src/OpenFOAM/primitives/Pair/Pair.H index ef30fb547f6..1a9ab62fc81 100644 --- a/src/OpenFOAM/primitives/Pair/Pair.H +++ b/src/OpenFOAM/primitives/Pair/Pair.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -28,7 +28,7 @@ Description An ordered pair of two objects of type \<T\> with first() and second() elements. -SeeAlso +See also Foam::Tuple2 for storing two objects of dissimilar types. \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/primitives/Tensor/Tensor.H b/src/OpenFOAM/primitives/Tensor/Tensor.H index 3b9165f652b..ee670f07b9e 100644 --- a/src/OpenFOAM/primitives/Tensor/Tensor.H +++ b/src/OpenFOAM/primitives/Tensor/Tensor.H @@ -33,7 +33,7 @@ Description SourceFiles TensorI.H -SeeAlso +See also Foam::MatrixSpace Foam::Vector diff --git a/src/OpenFOAM/primitives/Tuple2/Tuple2.H b/src/OpenFOAM/primitives/Tuple2/Tuple2.H index 4b7b45a1f84..6b556af0fa1 100644 --- a/src/OpenFOAM/primitives/Tuple2/Tuple2.H +++ b/src/OpenFOAM/primitives/Tuple2/Tuple2.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description A 2-tuple for storing two objects of different types. -SeeAlso +See also Foam::Pair for storing two objects of identical types. \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/primitives/chars/wchar/wchar.H b/src/OpenFOAM/primitives/chars/wchar/wchar.H index 2c8a9c8722c..e6cc3e182ec 100644 --- a/src/OpenFOAM/primitives/chars/wchar/wchar.H +++ b/src/OpenFOAM/primitives/chars/wchar/wchar.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description SourceFiles wcharIO.C -SeeAlso +See also http://en.wikipedia.org/wiki/UTF-8 http://en.wikibooks.org/wiki/Unicode/Character_reference diff --git a/src/OpenFOAM/primitives/functions/Polynomial/polynomialFunction.H b/src/OpenFOAM/primitives/functions/Polynomial/polynomialFunction.H index ba8e3538c9a..1fe767582d2 100644 --- a/src/OpenFOAM/primitives/functions/Polynomial/polynomialFunction.H +++ b/src/OpenFOAM/primitives/functions/Polynomial/polynomialFunction.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -39,7 +39,7 @@ Description - integralMinus1() to return a new, integral coeff polynomial where the base poly starts at order -1 -SeeAlso +See also Foam::Polynomial for a templated implementation SourceFiles diff --git a/src/OpenFOAM/primitives/hashes/Hasher/Hasher.H b/src/OpenFOAM/primitives/hashes/Hasher/Hasher.H index 1ee4094d6d3..7fcb086ec4b 100644 --- a/src/OpenFOAM/primitives/hashes/Hasher/Hasher.H +++ b/src/OpenFOAM/primitives/hashes/Hasher/Hasher.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -32,7 +32,7 @@ Description and has been reported to have better characteristics. It is also what postgresql seems to be using. -SeeAlso +See also http://burtleburtle.net/bob/c/lookup3.c and HasherInt.H for a specialized version diff --git a/src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H b/src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H index 4e4fa0de6b6..bad2cdd5c99 100644 --- a/src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H +++ b/src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ InNamespace Description Optimized hashing functions. -SeeAlso +See also Hasher.H \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/primitives/hashes/SHA1/SHA1.H b/src/OpenFOAM/primitives/hashes/SHA1/SHA1.H index 8745c3481f7..e86b045d193 100644 --- a/src/OpenFOAM/primitives/hashes/SHA1/SHA1.H +++ b/src/OpenFOAM/primitives/hashes/SHA1/SHA1.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description Adapted from the gnulib implementation. -SeeAlso +See also Foam::SHA1Digest SourceFiles diff --git a/src/OpenFOAM/primitives/hashes/SHA1/SHA1Digest.H b/src/OpenFOAM/primitives/hashes/SHA1/SHA1Digest.H index 4c1b1b6b980..9a2105893d4 100644 --- a/src/OpenFOAM/primitives/hashes/SHA1/SHA1Digest.H +++ b/src/OpenFOAM/primitives/hashes/SHA1/SHA1Digest.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description The SHA1 message digest. -SeeAlso +See also Foam::SHA1 SourceFiles diff --git a/src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensor/CompactSpatialTensor.H b/src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensor/CompactSpatialTensor.H index 4f2e0bbd3da..1f051d919f4 100644 --- a/src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensor/CompactSpatialTensor.H +++ b/src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensor/CompactSpatialTensor.H @@ -39,7 +39,7 @@ Description SourceFiles CompactSpatialTensorI.H -SeeAlso +See also Foam::MatrixSpace Foam::SpatialTensor diff --git a/src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensorT/CompactSpatialTensorT.H b/src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensorT/CompactSpatialTensorT.H index fbb1d6adf63..d22dc5744d5 100644 --- a/src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensorT/CompactSpatialTensorT.H +++ b/src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensorT/CompactSpatialTensorT.H @@ -38,7 +38,7 @@ Description SourceFiles CompactSpatialTensorTI.H -SeeAlso +See also Foam::MatrixSpace Foam::CompactSpatialTensor diff --git a/src/OpenFOAM/primitives/spatialVectorAlgebra/SpatialTensor/SpatialTensor.H b/src/OpenFOAM/primitives/spatialVectorAlgebra/SpatialTensor/SpatialTensor.H index 04d53b5979b..ab9f0d12ec4 100644 --- a/src/OpenFOAM/primitives/spatialVectorAlgebra/SpatialTensor/SpatialTensor.H +++ b/src/OpenFOAM/primitives/spatialVectorAlgebra/SpatialTensor/SpatialTensor.H @@ -39,7 +39,7 @@ Description SourceFiles SpatialTensorI.H -SeeAlso +See also Foam::MatrixSpace Foam::Tensor Foam::SpatialVector diff --git a/src/OpenFOAM/primitives/spatialVectorAlgebra/SpatialVector/SpatialVector.H b/src/OpenFOAM/primitives/spatialVectorAlgebra/SpatialVector/SpatialVector.H index c56a7e06d69..f162b891800 100644 --- a/src/OpenFOAM/primitives/spatialVectorAlgebra/SpatialVector/SpatialVector.H +++ b/src/OpenFOAM/primitives/spatialVectorAlgebra/SpatialVector/SpatialVector.H @@ -39,7 +39,7 @@ Description SourceFiles SpatialVectorI.H -SeeAlso +See also Foam::VectorSpace Foam::Vector diff --git a/src/OpenFOAM/primitives/strings/string/string.H b/src/OpenFOAM/primitives/strings/string/string.H index 4b75a385234..67d6b2b6889 100644 --- a/src/OpenFOAM/primitives/strings/string/string.H +++ b/src/OpenFOAM/primitives/strings/string/string.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -32,7 +32,7 @@ Description Used as a base class for word and fileName. -See Also +See also Foam::findEtcFile() for information about the site/user OpenFOAM configuration directory diff --git a/src/OpenFOAM/primitives/triad/triad.H b/src/OpenFOAM/primitives/triad/triad.H index abe8ad0d27f..30eaba81c12 100644 --- a/src/OpenFOAM/primitives/triad/triad.H +++ b/src/OpenFOAM/primitives/triad/triad.H @@ -27,7 +27,7 @@ Class Description Representation of a 3D Cartesian coordinate system as a Vector of vectors. -See Also +See also Foam::quaternion SourceFiles diff --git a/src/TurbulenceModels/compressible/RAS/buoyantKEpsilon/buoyantKEpsilon.H b/src/TurbulenceModels/compressible/RAS/buoyantKEpsilon/buoyantKEpsilon.H index 0b29d2481d6..b92b3557bd6 100644 --- a/src/TurbulenceModels/compressible/RAS/buoyantKEpsilon/buoyantKEpsilon.H +++ b/src/TurbulenceModels/compressible/RAS/buoyantKEpsilon/buoyantKEpsilon.H @@ -53,7 +53,7 @@ Description } \endverbatim -SeeAlso +See also Foam::RASModels::kEpsilon SourceFiles diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H index f98ee20874e..90eba83b1ec 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H @@ -66,7 +66,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H index 7363c4cd2e3..ad63aa6526a 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H @@ -106,7 +106,7 @@ Usage } \endverbatim -SeeAlso +See also mixedFvPatchField externalCoupledMixedFvPatchField diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H index ded11e59778..0caa3cb406e 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H @@ -85,7 +85,7 @@ Usage - Only supply \c h and \c Ta, or \c q in the dictionary (see above) - \c kappa and \c kappaName are inherited from temperatureCoupledBase. -SeeAlso +See also Foam::temperatureCoupledBase SourceFiles diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H index 0978cc58519..5a9d914e066 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H @@ -58,7 +58,7 @@ Usage \endverbatim -SeeAlso +See also Foam::temperatureCoupledBase SourceFiles diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H index 86d954eec8c..7c6fb3ac2b9 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H @@ -73,7 +73,7 @@ Usage - \c kappa and \c kappaName are inherited from temperatureCoupledBase. -SeeAlso +See also Foam::temperatureCoupledBase SourceFiles diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H index 2f3aad04eaf..6c9413dcd40 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H @@ -70,7 +70,7 @@ Usage - \c kappa and \c kappaName are inherited from temperatureCoupledBase. -SeeAlso +See also Foam::temperatureCoupledBase SourceFiles diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index 4771a556e40..f932003f727 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -53,7 +53,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatPhaseChangeWallFunction/alphatPhaseChangeWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatPhaseChangeWallFunction/alphatPhaseChangeWallFunctionFvPatchScalarField.H index 08d71a52ba0..763e71df514 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatPhaseChangeWallFunction/alphatPhaseChangeWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatPhaseChangeWallFunction/alphatPhaseChangeWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Group Description Abstract base-class for all alphatWallFunctions supporting phase-change. -SeeAlso +See also Foam::fixedValueFvPatchScalarField Foam::alphatWallFunctionFvPatchScalarField diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H index 037ada349ca..d937a1f2ef5 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H @@ -65,7 +65,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H index 8580991b9bc..8f0bf793e81 100644 --- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H +++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -48,7 +48,7 @@ Description wall-functions is also included to allow for low- and high-Reynolds number operation. -See Also +See also Foam::incompressible::RASModels::ShihQuadraticKE SourceFiles diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index 02ec46acb26..1b718f983c1 100644 --- a/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -52,7 +52,7 @@ Usage Note The units of kinematic turbulent thermal conductivity are [m2/s] -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/LES/Smagorinsky/Smagorinsky.H b/src/TurbulenceModels/turbulenceModels/LES/Smagorinsky/Smagorinsky.H index b1eb383b0ca..83a150127dc 100644 --- a/src/TurbulenceModels/turbulenceModels/LES/Smagorinsky/Smagorinsky.H +++ b/src/TurbulenceModels/turbulenceModels/LES/Smagorinsky/Smagorinsky.H @@ -61,7 +61,7 @@ Description } \endverbatim -SeeAlso +See also Foam::LESModels::kEqn SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/LES/WALE/WALE.H b/src/TurbulenceModels/turbulenceModels/LES/WALE/WALE.H index 0c2732b3a3e..0e55cdef2ff 100644 --- a/src/TurbulenceModels/turbulenceModels/LES/WALE/WALE.H +++ b/src/TurbulenceModels/turbulenceModels/LES/WALE/WALE.H @@ -48,7 +48,7 @@ Description } \endverbatim -SeeAlso +See also Foam::LESModels::Smagorinsky SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/LES/kOmegaSSTDES/kOmegaSSTDES.H b/src/TurbulenceModels/turbulenceModels/LES/kOmegaSSTDES/kOmegaSSTDES.H index 014f30e9bfb..213de48d4e3 100644 --- a/src/TurbulenceModels/turbulenceModels/LES/kOmegaSSTDES/kOmegaSSTDES.H +++ b/src/TurbulenceModels/turbulenceModels/LES/kOmegaSSTDES/kOmegaSSTDES.H @@ -45,7 +45,7 @@ Description Group grpLESTurbulence -SeeAlso +See also Foam::kOmegaSST SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H index 0015b42c14b..a73e9439759 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -46,7 +46,7 @@ Description } \endverbatim -SeeAlso +See also Foam::atmBoundaryLayer, Foam::atmBoundaryLayerInletVelocityFvPatchVectorField, Foam::atmBoundaryLayerInletKFvPatchScalarField diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletK/atmBoundaryLayerInletKFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletK/atmBoundaryLayerInletKFvPatchScalarField.H index cc95eca33a7..b0cac8c4dcc 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletK/atmBoundaryLayerInletKFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletK/atmBoundaryLayerInletKFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2014-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2014-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -46,7 +46,7 @@ Description } \endverbatim -SeeAlso +See also Foam::atmBoundaryLayer, Foam::atmBoundaryLayerInletVelocityFvPatchVectorField, Foam::atmBoundaryLayerInletEpsilonFvPatchScalarField diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H index ca9579b6c73..7a22c0ef322 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -47,7 +47,7 @@ Description } \endverbatim -SeeAlso +See also Foam::atmBoundaryLayer, Foam::atmBoundaryLayerInletKFvPatchScalarField, Foam::atmBoundaryLayerInletEpsilonFvPatchScalarField diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index 342b61460a6..eaf7aa8a4e0 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -67,7 +67,7 @@ Usage Note In the event of reverse flow, a zero-gradient condition is applied -SeeAlso +See also Foam::inletOutletFvPatchField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 08d4730e98b..9d2cc294e13 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -67,7 +67,7 @@ Usage Note In the event of reverse flow, a zero-gradient condition is applied -SeeAlso +See also Foam::inletOutletFvPatchField diff --git a/src/TurbulenceModels/turbulenceModels/RAS/kOmegaSST/kOmegaSST.H b/src/TurbulenceModels/turbulenceModels/RAS/kOmegaSST/kOmegaSST.H index 351b0cee595..b5483bc79d5 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/kOmegaSST/kOmegaSST.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/kOmegaSST/kOmegaSST.H @@ -27,7 +27,7 @@ Class Group grpRASTurbulence -SeeAlso +See also Foam::kOmegaSST SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.H b/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.H index d8a22ed4401..2dcb6fce389 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.H @@ -86,7 +86,7 @@ Note viscosity wall function should be used, e.g. nutUWallFunction. Turbulence k variants (nutk...) for this case will not behave correctly. -SeeAlso +See also Foam::RASModels::v2fBase Foam::RASModels::kEpsilon Foam::kLowReWallFunctionFvPatchScalarField diff --git a/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2fBase.H b/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2fBase.H index 87f249dd4a2..274abedbfd8 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2fBase.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/v2f/v2fBase.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -31,7 +31,7 @@ Description Abstract base-class for v2-f models to provide BCs access to the v2 and f fields. -SeeAlso +See also Foam::RASModels::v2f SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H index 795575006ba..21c5f12db59 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H @@ -55,7 +55,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::epsilonWallFunctionFvPatchScalarField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index 74aa761fcb6..d77dadc3e77 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -60,7 +60,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedInternalValueFvPatchField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H index 8fd4c9fe90c..5d627780139 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H @@ -51,7 +51,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H index bb34c3fd981..02a3bd7ef4d 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H @@ -52,7 +52,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index ad72e76887c..1fdfe933dfb 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -44,7 +44,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::zeroGradientFvPatchField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H index 910e85330c1..c1acfded6bb 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H @@ -42,7 +42,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::nutWallFunctionFvPatchScalarField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H index 3c57a711103..7958e26817a 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H @@ -51,7 +51,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::nutWallFunctionFvPatchScalarField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H index d4f94a10ea7..dda5793e1e7 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H @@ -55,7 +55,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::nutWallFunctionFvPatchScalarField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H index 160ca78f4ac..477872fbf19 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H @@ -53,7 +53,7 @@ Note The tables are not registered since the same table object may be used for more than one patch. -SeeAlso +See also Foam::nutWallFunctionFvPatchScalarField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H index 4998b92cc17..d3fbbeb2f78 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H @@ -41,7 +41,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::nutWallFunctionFvPatchScalarField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H index 10f34431677..ab06f04d6c8 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H @@ -57,7 +57,7 @@ Usage Method, subsection "3.5.2 k-epsilon model" \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H index efad1f6e90c..2704c4c97f9 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H @@ -62,7 +62,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::nutkWallFunctionFvPatchField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H index 6cb99892493..99983355081 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H @@ -55,7 +55,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::nutkRoughWallFunctionFvPatchScalarField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H index 8b056e9fd82..5247fd7b2b2 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H @@ -42,7 +42,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::nutWallFunctionFvPatchScalarField SourceFiles diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H index 11cac43c750..1055a5a5d4f 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H @@ -53,7 +53,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/SDA/SDA.H b/src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/SDA/SDA.H index 4bbae17a9e1..9c294be8056 100644 --- a/src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/SDA/SDA.H +++ b/src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/SDA/SDA.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description Comprising sinusoidal roll (rotation about x), heave (z-translation) and sway (y-translation) motions with changing amplitude and phase. -See Also +See also Foam::solidBodyMotionFunctions::tabulated6DoFMotion SourceFiles diff --git a/src/edgeMesh/edgeMeshFormats/starcd/STARCDedgeFormat.H b/src/edgeMesh/edgeMeshFormats/starcd/STARCDedgeFormat.H index 1e4e7d09630..bc5a0ec1bbc 100644 --- a/src/edgeMesh/edgeMeshFormats/starcd/STARCDedgeFormat.H +++ b/src/edgeMesh/edgeMeshFormats/starcd/STARCDedgeFormat.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description Note Uses the extension \a .inp (input) to denote the format. -See Also +See also Foam::meshReaders::STARCD SourceFiles diff --git a/src/edgeMesh/featureEdgeMesh/featureEdgeMesh.H b/src/edgeMesh/featureEdgeMesh/featureEdgeMesh.H index 686701e0fbd..2792abf670b 100644 --- a/src/edgeMesh/featureEdgeMesh/featureEdgeMesh.H +++ b/src/edgeMesh/featureEdgeMesh/featureEdgeMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description edgeMesh + IO. -See Also +See also Foam::extendedFeatureEdgeMesh SourceFiles diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H index e77bf9c74ad..dabab17c64f 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H @@ -65,7 +65,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::freestreamFvPatchField Foam::SRFVelocityFvPatchVectorField diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H index 86e3b38303d..2eeae499a92 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H @@ -77,7 +77,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H index ed101b672f4..5f967c33694 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H @@ -58,7 +58,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::SRFModel Foam::SRFVelocityFvPatchVectorField Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index b8d9ebc5aba..b51e69adcc6 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -61,7 +61,7 @@ Note This condition is not usually applied directly; instead, use a derived mixed condition such as \c inletOutlet -SeeAlso +See also Foam::inletOutletFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H index 7f783ce6952..75fe5871972 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H @@ -36,7 +36,7 @@ Description Should only used as a template argument for SlicedGeometricField. -SeeAlso +See also Foam::fvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H index 18c802ee25f..b371c900282 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H @@ -42,7 +42,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::AMIInterpolation SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index ba7fd1e3101..ef5cdcc961d 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -47,7 +47,7 @@ Note patch is transformed to the neighbour patch, the outer perimiter of each patch should be identical (or very similar). -SeeAlso +See also Foam::AMIInterpolation SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H index a1a4b8ae76b..57a5f7df2e2 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H @@ -41,7 +41,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::cyclicFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H index 07eadc8c54c..2456df9bbaa 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a base class for coupled-cyclic conditions with a specified 'jump' (or offset) between the values -SeeAlso +See also Foam::cyclicFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclicAMI/jumpCyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclicAMI/jumpCyclicAMIFvPatchField.H index 3a9bb130af2..0815af948f1 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclicAMI/jumpCyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclicAMI/jumpCyclicAMIFvPatchField.H @@ -33,7 +33,7 @@ Description whereby communication between the patches is performed using an arbitrary mesh interface (AMI) interpolation. -SeeAlso +See also Foam::cyclicAMIFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H index 4ea304fa3e3..bdc81a727bc 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H @@ -41,7 +41,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::processorFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H index d304b53df50..d8aef9e6ef9 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H @@ -41,7 +41,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::cyclicFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H index 505032cd1cb..b4639cf184f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H @@ -80,7 +80,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField Foam::cyclicFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index fc87f082e99..9b7097b44d3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -72,7 +72,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::dynamicCode Foam::functionEntries::codeStream diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index 779a85906d4..7484cbc8003 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -82,7 +82,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::dynamicCode Foam::functionEntries::codeStream diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index 3b0f153e88e..1a2843d41f5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -61,7 +61,7 @@ Note types, able to describe time varying functions. The example above gives the usage for supplying constant values. -SeeAlso +See also Foam::fixedValueFvPatchField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H index 271b659b0e3..b5dc098aef9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H @@ -108,7 +108,7 @@ Usage } \endverbatim -SeeAlso +See also mixedFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index 0e22cc086ac..2bda5a59890 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -69,7 +69,7 @@ Usage Note The underlying \c patchType should be set to \c cyclic -SeeAlso +See also Foam::Function1Types SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H index 79dc72841d2..74b69ab133b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H @@ -64,7 +64,7 @@ Usage } \endverbatim -See Also +See also Foam::fanFvPatchField Foam::totalPressureFvPatchScalarField Foam::interpolationTable diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxExtrapolatedPressure/fixedFluxExtrapolatedPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxExtrapolatedPressure/fixedFluxExtrapolatedPressureFvPatchScalarField.H index 062e08b772a..382d6b3dba3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxExtrapolatedPressure/fixedFluxExtrapolatedPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxExtrapolatedPressure/fixedFluxExtrapolatedPressureFvPatchScalarField.H @@ -40,7 +40,7 @@ Description } \endverbatim -SeeAlso +See also Foam::fixedGradientFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H index b2f8b7c126a..f60932280d1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H @@ -40,7 +40,7 @@ Description } \endverbatim -SeeAlso +See also Foam::fixedGradientFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index d717ccdf66f..7870fa71269 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -48,7 +48,7 @@ Note wall function, which applies a near-wall constraint for high Reynolds number flows. -SeeAlso +See also Foam::epsilonWallFunctionFvPatchScalarField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index ec739d6bcfa..6f81586f177 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H @@ -57,7 +57,7 @@ Usage Note The underlying \c patchType should be set to \c cyclic -SeeAlso +See also Foam::jumpCyclicFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H index 3b34f3ae979..7e5ebaa86af 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H @@ -57,7 +57,7 @@ Usage Note The underlying \c patchType should be set to \c cyclicAMI -SeeAlso +See also Foam::jumpCyclicAMIFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H index 04eb221243f..f3fc4d9128e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H @@ -48,7 +48,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H index 6c0fe30efe8..48391c4e4eb 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H @@ -46,7 +46,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::transformFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H index b818b7f4a41..98d701efab7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H @@ -65,7 +65,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H index 18ff2a8b6f6..15d7af290bf 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H @@ -82,7 +82,7 @@ Note The profile entry is a Function1 type. The example above gives the usage for supplying csv file. -SeeAlso +See also Foam::fixedValueFvPatchField Foam::Function1Types Foam::timeVaryingMappedFixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index 4d6ce71ef6d..4ba85279931 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -85,7 +85,7 @@ Note - May not work correctly for transonic inlets - Strange behaviour with potentialFoam since the U equation is not solved -SeeAlso +See also Foam::fixedValueFvPatchField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 7ac6d32b46e..3014e4cfafe 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -68,7 +68,7 @@ Note If reverse flow is possible or expected use the pressureInletOutletVelocity condition instead. -SeeAlso +See also Foam::zeroGradientFvPatchField Foam::pressureInletOutletVelocityFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H index 518d694d262..18f02531470 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H @@ -50,7 +50,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::mixedFvPatchField Foam::inletOutletFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index 653e985c396..56ec09a66d1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -52,7 +52,7 @@ Usage Note This condition is designed to operate with a freestream velocity condition -SeeAlso +See also Foam::zeroGradientFvPatchField Foam::freestreamFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index a7b869c437f..06ae68b5441 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -58,7 +58,7 @@ Note - Positive flux (out of domain): apply zero-gradient condition - Negative flux (into of domain): apply the "inletValue" fixed-value -SeeAlso +See also Foam::mixedFvPatchField Foam::zeroGradientFvPatchField Foam::outletInletFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H index 0c286dce91b..526b50cee09 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H @@ -59,7 +59,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::inletOutletFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index d1ef4849012..72f2e59ff1c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -60,7 +60,7 @@ Note employ this condition if it is not possible to change the underlying geometric (poly) patch type to \c mapped. -SeeAlso +See also Foam::mappedPatchBase Foam::mappedPolyPatch Foam::mappedFvPatch diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index 88bb0bd6d29..c3971cd4fdf 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -55,7 +55,7 @@ Note This boundary condition can only be applied to patches that are of the \c mappedPolyPatch type. -SeeAlso +See also Foam::mappedPatchBase Foam::mappedPolyPatch Foam::mappedFvPatch diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index c2c205ba2aa..715c4043a1f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -56,7 +56,7 @@ Note This boundary condition can only be applied to patches that are of the \c mappedPolyPatch type. -SeeAlso +See also Foam::mappedPatchBase Foam::mappedPolyPatch Foam::mappedFvPatch diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index aec2fa02cc6..c3d83898c26 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -69,7 +69,7 @@ Note It is not possible to sample internal faces since volume fields are not defined on faces. -SeeAlso +See also Foam::mappedPatchBase Foam::interpolation Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index 0be0ae4b817..ffe67be23ba 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -55,7 +55,7 @@ Note This boundary condition can only be applied to patches that are of the \c mappedPolyPatch type. -SeeAlso +See also Foam::mappedPatchBase Foam::mappedPolyPatch Foam::mappedFvPatch diff --git a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H index 8d74b0004b4..67f97dd20ee 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H @@ -43,7 +43,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchVectorField Foam::MRFZone diff --git a/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H index 71e243a16fc..329b62da4cd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H @@ -40,7 +40,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchVectorField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index ab8929e04ed..5de54e9f1c1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -58,7 +58,7 @@ Note - Positive flux (out of domain): apply the "outletValue" fixed-value - Negative flux (into of domain): apply zero-gradient condition -SeeAlso +See also Foam::mixedFvPatchField Foam::zeroGradientFvPatchField Foam::inletOutletFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H index 91cac5eb6a8..65169d8eda7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H @@ -51,7 +51,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H index ce5d31662cb..7a1fd6c58cd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H @@ -53,7 +53,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::mixedFvPatchField Foam::variableHeightFlowRateInletVelocityFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H index 8840d624177..e74b0f6bdb0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H @@ -48,7 +48,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::transformFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H index ea19e81d7b5..6eb0855234d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H @@ -71,7 +71,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::mixedFvPatchScalarField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index 9ee05bc3db9..d52c186d28c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -60,7 +60,7 @@ Note - negative flux (into of domain): derive from the flux with specified direction -SeeAlso +See also Foam::mixedFvPatchVectorField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index 574239441c6..96c3a7afcff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -58,7 +58,7 @@ Note pressureDirectedInletOutletVelocityFvPatchVectorField condition instead. -SeeAlso +See also Foam::fixedValueFvPatchField Foam::pressureDirectedInletOutletVelocityFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index e67075ee1ae..67ffcd0ca4f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -58,7 +58,7 @@ Note - negative flux (into of domain): derive from the flux with specified direction -SeeAlso +See also Foam::mixedFvPatchVectorField Foam::pressureDirectedInletOutletVelocityFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index 5d21154ce37..4253b2ad50c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -49,7 +49,7 @@ Note If reverse flow is possible or expected use the pressureInletOutletVelocityFvPatchVectorField condition instead. -SeeAlso +See also Foam::fixedValueFvPatchField Foam::pressureInletOutletVelocityFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index a3c2aaf37ad..52766d7121f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -58,7 +58,7 @@ Note - negative flux (into of domain): derive from the flux and patch-normal direction -SeeAlso +See also Foam::mixedFvPatchVectorField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H index e16d1a49f01..2c54638a8bd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H @@ -64,7 +64,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchScalarField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H index 3a6dee574c3..64901c8c087 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H @@ -65,7 +65,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchScalarField Foam::prghTotalPressureFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H index 2e38f9bca3b..138e941601b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H @@ -66,7 +66,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchScalarField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index 8d3e5ae7964..0ff40f8756c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -62,7 +62,7 @@ Note - negative flux (into of domain): derive from the flux in the patch-normal direction -SeeAlso +See also Foam::pressureInletOutletVelocityFvPatchVectorField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H index 535e106ff10..f1486e113dd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H @@ -62,7 +62,7 @@ Usage The \c omega entry is a Function1 type, able to describe time varying functions. -SeeAlso +See also Foam::totalPressureFvPatchScalarField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H index bc0a360aa89..9d5c2ff9f97 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H @@ -52,7 +52,7 @@ Usage The \c omega entry is a Function1 of time, see Foam::Function1Types. -SeeAlso +See also Foam::fixedValueFvPatchField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 9593fae850d..935eceb5790 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -51,7 +51,7 @@ Note Sign conventions: - the value is positive for outward-pointing vectors -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index 7f8041543cd..16d750f1bae 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -63,7 +63,7 @@ Note constant values. - the value is positive into the domain -SeeAlso +See also Foam::fixedValueFvPatchField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H index dc25e326e76..1695a1e32f9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H @@ -72,7 +72,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index c61fd82730b..2ea101c4829 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -65,7 +65,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H index 49af6162c7f..4cbc84763ff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H @@ -111,7 +111,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H index b32f0ac2eec..0abbcee5f6d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H @@ -53,7 +53,7 @@ Usage SourceFiles totalTemperatureFvPatchScalarField.C -SeeAlso +See also Foam::fixedValueFvPatchField \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H index f2239da4902..2302c84f30f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H @@ -50,7 +50,7 @@ Usage The \c U entry is a Function1 of time, see Foam::Function1Types. -SeeAlso +See also Foam::fixedValueFvPatchField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H index 62fabb1db47..585be2d45b9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H @@ -66,7 +66,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H index a10ce7b1230..79977bd7c98 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H @@ -65,7 +65,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::inletOutletFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H index 93885835a08..9566a0601b6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H @@ -51,7 +51,7 @@ Note varying functions. The example above gives the usage for supplying a constant value. -SeeAlso +See also Foam::Function1Types Foam::fixedGradientFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index cec8401ea29..6e6fd3e49ee 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -51,7 +51,7 @@ Note varying functions. The example above gives the usage for supplying a constant value. -SeeAlso +See also Foam::Function1Types Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H index c1749b633c2..d1f3eab9dc4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H @@ -57,7 +57,7 @@ Note - positive flux (out of domain): apply zero-gradient condition - negative flux (into of domain): apply the user-specified fixed value -SeeAlso +See also Foam::inletOutletFvPatchField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H index f126828c2db..5cc5e726aac 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H @@ -59,7 +59,7 @@ Note The underlying \c patchType should be set to \c cyclic -SeeAlso +See also Foam::fixedJumpFvPatchField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H index 90c2301117a..c0497cbea55 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H @@ -59,7 +59,7 @@ Note The underlying \c patchType should be set to \c cyclic -SeeAlso +See also Foam::jumpCyclicAMIFvPatchField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index 22920e554e9..a4f15cfe928 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -55,7 +55,7 @@ Usage The \c p0 entry is specified as a Function1 type, able to describe time varying functions. -SeeAlso +See also Foam::Function1Types Foam::uniformFixedValueFvPatchField Foam::totalPressureFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index 956107dab36..425a1919312 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -61,7 +61,7 @@ Note - strange behaviour with potentialFoam since the momentum equation is not solved -SeeAlso +See also Foam::fixedValueFvPatchField Foam::Function1Types diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H index 24a4ac9bf4b..94747192734 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H @@ -68,7 +68,7 @@ Usage The density field is only required if the flux is mass-based as opposed to volumetric-based. -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H index 608ee59cc34..7758f60915f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H @@ -68,7 +68,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::advectiveFvPatchField SourceFiles diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H index 14d6947a1c2..62d6778f0c9 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H @@ -63,7 +63,7 @@ Note cnCoeff = 1.0/(1.0 + ocCoeff); \endverbatim -See Also +See also Foam::Euler Foam::backward diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/SLTSDdtScheme/SLTSDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/SLTSDdtScheme/SLTSDdtScheme.H index edfcdb4043c..240dc5e8be5 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/SLTSDdtScheme/SLTSDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/SLTSDdtScheme/SLTSDdtScheme.H @@ -33,7 +33,7 @@ Description using transient codes where local time-stepping is preferably to under-relaxation for transport consistency reasons. -See Also +See also Foam::fv::CoEulerDdtScheme SourceFiles diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/localEulerDdtScheme/localEulerDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/localEulerDdtScheme/localEulerDdtScheme.H index 5ea0b2127f3..73ba7777a86 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/localEulerDdtScheme/localEulerDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/localEulerDdtScheme/localEulerDdtScheme.H @@ -33,7 +33,7 @@ Description transient codes where local time-stepping is preferably to under-relaxation for transport consistency reasons. -See Also +See also Foam::fv::CoEulerDdtScheme SourceFiles diff --git a/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H b/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H index 93aee393d87..d7ec1b4de7e 100644 --- a/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H +++ b/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H @@ -48,7 +48,7 @@ Usage } \endverbatim -See Also +See also Foam::fv::LeastSquaresVectors Foam::fv::leastSquaresGrad diff --git a/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresVectors.H b/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresVectors.H index d187f4d3829..6bfa278dff0 100644 --- a/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresVectors.H +++ b/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresVectors.H @@ -27,7 +27,7 @@ Class Description Least-squares gradient scheme vectors -See Also +See also Foam::fv::LeastSquaresGrad SourceFiles diff --git a/src/finiteVolume/fvMesh/fvMeshFunctionObject/fvMeshFunctionObject.H b/src/finiteVolume/fvMesh/fvMeshFunctionObject/fvMeshFunctionObject.H index 6e2477fc473..1d10616e63c 100644 --- a/src/finiteVolume/fvMesh/fvMeshFunctionObject/fvMeshFunctionObject.H +++ b/src/finiteVolume/fvMesh/fvMeshFunctionObject/fvMeshFunctionObject.H @@ -31,7 +31,7 @@ Description If the selected region is not an Foam::fvMesh a Foam::FatalError will be generated. -SeeAlso +See also Foam::regionFunctionObject Foam::functionObject diff --git a/src/finiteVolume/fvMesh/wallDist/patchDistMethods/Poisson/PoissonPatchDistMethod.H b/src/finiteVolume/fvMesh/wallDist/patchDistMethods/Poisson/PoissonPatchDistMethod.H index 98259f7b425..b2be9da2b66 100644 --- a/src/finiteVolume/fvMesh/wallDist/patchDistMethods/Poisson/PoissonPatchDistMethod.H +++ b/src/finiteVolume/fvMesh/wallDist/patchDistMethods/Poisson/PoissonPatchDistMethod.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -90,7 +90,7 @@ Description } \endverbatim -SeeAlso +See also Foam::patchDistMethod::meshWave Foam::wallDist diff --git a/src/finiteVolume/fvMesh/wallDist/patchDistMethods/advectionDiffusion/advectionDiffusionPatchDistMethod.H b/src/finiteVolume/fvMesh/wallDist/patchDistMethods/advectionDiffusion/advectionDiffusionPatchDistMethod.H index be8a2489e64..cd2113d6735 100644 --- a/src/finiteVolume/fvMesh/wallDist/patchDistMethods/advectionDiffusion/advectionDiffusionPatchDistMethod.H +++ b/src/finiteVolume/fvMesh/wallDist/patchDistMethods/advectionDiffusion/advectionDiffusionPatchDistMethod.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -152,7 +152,7 @@ Description } \endverbatim -SeeAlso +See also Foam::patchDistMethod::Poisson Foam::patchDistMethod::meshWave Foam::wallDist diff --git a/src/finiteVolume/fvMesh/wallDist/patchDistMethods/meshWave/meshWavePatchDistMethod.H b/src/finiteVolume/fvMesh/wallDist/patchDistMethods/meshWave/meshWavePatchDistMethod.H index 0a309038081..0ed9aef4f70 100644 --- a/src/finiteVolume/fvMesh/wallDist/patchDistMethods/meshWave/meshWavePatchDistMethod.H +++ b/src/finiteVolume/fvMesh/wallDist/patchDistMethods/meshWave/meshWavePatchDistMethod.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -46,7 +46,7 @@ Description } \endverbatim -SeeAlso +See also Foam::patchDistMethod::Poisson Foam::wallDist diff --git a/src/finiteVolume/fvMesh/wallDist/wallDist/wallDist.H b/src/finiteVolume/fvMesh/wallDist/wallDist/wallDist.H index 9d4f0263b42..4aa5cffd715 100644 --- a/src/finiteVolume/fvMesh/wallDist/wallDist/wallDist.H +++ b/src/finiteVolume/fvMesh/wallDist/wallDist/wallDist.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -40,7 +40,7 @@ Description } \endverbatim -SeeAlso +See also Foam::patchDistMethod::meshWave Foam::patchDistMethod::Poisson Foam::patchDistMethod::advectionDiffusion diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cellCoBlended/cellCoBlended.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cellCoBlended/cellCoBlended.H index 8492479b771..a2f1e3bea21 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cellCoBlended/cellCoBlended.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cellCoBlended/cellCoBlended.H @@ -58,7 +58,7 @@ Description } \endverbatim -See Also +See also Foam::CoBlended Foam::localBlended diff --git a/src/functionObjects/field/CourantNo/CourantNo.H b/src/functionObjects/field/CourantNo/CourantNo.H index 346cd2bb7ed..bce919f4802 100644 --- a/src/functionObjects/field/CourantNo/CourantNo.H +++ b/src/functionObjects/field/CourantNo/CourantNo.H @@ -32,7 +32,7 @@ Description volScalarField. The field is stored on the mesh database so that it can be retrieved and used for other applications. -SeeAlso +See also Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/Lambda2/Lambda2.H b/src/functionObjects/field/Lambda2/Lambda2.H index f94e6cd1d73..40402f80ae0 100644 --- a/src/functionObjects/field/Lambda2/Lambda2.H +++ b/src/functionObjects/field/Lambda2/Lambda2.H @@ -32,7 +32,7 @@ Description of the sum of the square of the symmetrical and anti-symmetrical parts of the velocity gradient tensor. -SeeAlso +See also Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/MachNo/MachNo.H b/src/functionObjects/field/MachNo/MachNo.H index 342647cd908..0e5a934ebda 100644 --- a/src/functionObjects/field/MachNo/MachNo.H +++ b/src/functionObjects/field/MachNo/MachNo.H @@ -31,7 +31,7 @@ Description This function object calculates and writes the Mach number as a volScalarField. -SeeAlso +See also Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/PecletNo/PecletNo.H b/src/functionObjects/field/PecletNo/PecletNo.H index bd333a1a131..2efe7ace8de 100644 --- a/src/functionObjects/field/PecletNo/PecletNo.H +++ b/src/functionObjects/field/PecletNo/PecletNo.H @@ -31,7 +31,7 @@ Description This function object calculates and outputs the Peclet number as a surfaceScalarField. -SeeAlso +See also Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/Q/Q.H b/src/functionObjects/field/Q/Q.H index 1305b02b1f6..cfff507d557 100644 --- a/src/functionObjects/field/Q/Q.H +++ b/src/functionObjects/field/Q/Q.H @@ -35,7 +35,7 @@ Description Q = 0.5(sqr(tr(\nabla U)) - tr(((\nabla U) \cdot (\nabla U)))) \f] -SeeAlso +See also Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/blendingFactor/blendingFactor.H b/src/functionObjects/field/blendingFactor/blendingFactor.H index 9ab4c1a0268..0fa3aea2a2b 100644 --- a/src/functionObjects/field/blendingFactor/blendingFactor.H +++ b/src/functionObjects/field/blendingFactor/blendingFactor.H @@ -32,7 +32,7 @@ Description the bended convection schemes. The output is a volume field (cells) whose value is calculated via the maximum blending factor for any cell face. -SeeAlso +See also Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/components/components.H b/src/functionObjects/field/components/components.H index 4f23344dc98..b801a65330a 100644 --- a/src/functionObjects/field/components/components.H +++ b/src/functionObjects/field/components/components.H @@ -33,7 +33,7 @@ Description The operation can be applied to any volume or surface fields generating a volume or surface scalar fields for each component. -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/functionObjects/field/div/div.H b/src/functionObjects/field/div/div.H index 778147454f2..fe3ee7fb26c 100644 --- a/src/functionObjects/field/div/div.H +++ b/src/functionObjects/field/div/div.H @@ -32,7 +32,7 @@ Description limited to surfaceScalarFields and volVectorFields, and the output is a volScalarField. -SeeAlso +See also Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/enstrophy/enstrophy.H b/src/functionObjects/field/enstrophy/enstrophy.H index ae044e8aacf..f3d0a80b084 100644 --- a/src/functionObjects/field/enstrophy/enstrophy.H +++ b/src/functionObjects/field/enstrophy/enstrophy.H @@ -30,7 +30,7 @@ Group Description This function object calculates the enstrophy of the velocity. -SeeAlso +See also Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/fieldAverage/fieldAverage.H b/src/functionObjects/field/fieldAverage/fieldAverage.H index b3203855402..85cfd974d14 100644 --- a/src/functionObjects/field/fieldAverage/fieldAverage.H +++ b/src/functionObjects/field/fieldAverage/fieldAverage.H @@ -108,7 +108,7 @@ Usage Note To employ the \c prime2Mean option, the \c mean option must be selecetd. -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject Foam::functionObject diff --git a/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index a37975d6c67..2a261219d8b 100644 --- a/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -62,7 +62,7 @@ Usage coordinateSystem | local co-ordinate system | yes | \endtable -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject Foam::coordinateSystem diff --git a/src/functionObjects/field/fieldExpression/fieldExpression.H b/src/functionObjects/field/fieldExpression/fieldExpression.H index f0b949eb3ff..3c8647c0336 100644 --- a/src/functionObjects/field/fieldExpression/fieldExpression.H +++ b/src/functionObjects/field/fieldExpression/fieldExpression.H @@ -29,7 +29,7 @@ Group Description -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/functionObjects/field/fieldMinMax/fieldMinMax.H index c7d81015536..e6d1cefc3b4 100644 --- a/src/functionObjects/field/fieldMinMax/fieldMinMax.H +++ b/src/functionObjects/field/fieldMinMax/fieldMinMax.H @@ -65,7 +65,7 @@ Usage Output data is written to the file \<timeDir\>/fieldMinMax.dat -SeeAlso +See also Foam::functionObject Foam::functionObjects::writeFiles diff --git a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H index 75ccabb1aa7..39f0ab931fc 100644 --- a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H +++ b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H @@ -65,7 +65,7 @@ Usage average | average \endplaintable -SeeAlso +See also Foam::fieldValue SourceFiles diff --git a/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H b/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H index 25321e06a56..9c085b7e792 100644 --- a/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H +++ b/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H @@ -122,7 +122,7 @@ Note - take care when using isoSurfaces - these might have duplicate triangles and so integration might be wrong -SeeAlso +See also Foam::fieldValues Foam::functionObject diff --git a/src/functionObjects/field/fieldValues/volRegion/volRegion.H b/src/functionObjects/field/fieldValues/volRegion/volRegion.H index e81a74cb3f9..30625483ee2 100644 --- a/src/functionObjects/field/fieldValues/volRegion/volRegion.H +++ b/src/functionObjects/field/fieldValues/volRegion/volRegion.H @@ -90,7 +90,7 @@ Usage CoV | coefficient of variation: standard deviation/mean \endplaintable -SeeAlso +See also Foam::fieldValues Foam::functionObject diff --git a/src/functionObjects/field/flowType/flowType.H b/src/functionObjects/field/flowType/flowType.H index 54205736f40..78c05cc2d3e 100644 --- a/src/functionObjects/field/flowType/flowType.H +++ b/src/functionObjects/field/flowType/flowType.H @@ -41,7 +41,7 @@ Description 1 = planar extensional flow \endverbatim -SeeAlso +See also Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/grad/grad.H b/src/functionObjects/field/grad/grad.H index 36db751f317..c7415d99096 100644 --- a/src/functionObjects/field/grad/grad.H +++ b/src/functionObjects/field/grad/grad.H @@ -32,7 +32,7 @@ Description limited to scalar and vector volume or surface fields, and the output is a volume vector or tensor field. -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/functionObjects/field/histogram/histogram.H b/src/functionObjects/field/histogram/histogram.H index 40ea8e7b0a3..f09a8bcfc3b 100644 --- a/src/functionObjects/field/histogram/histogram.H +++ b/src/functionObjects/field/histogram/histogram.H @@ -57,7 +57,7 @@ Usage setFormat | Output format | yes | \endtable -SeeAlso +See also Foam::functionObject Foam::functionObjects::writeFile diff --git a/src/functionObjects/field/mag/mag.H b/src/functionObjects/field/mag/mag.H index 87ba471172d..c2ec19355d7 100644 --- a/src/functionObjects/field/mag/mag.H +++ b/src/functionObjects/field/mag/mag.H @@ -33,7 +33,7 @@ Description The operation can be applied to any volume or surface fields generating a volume or surface scalar field. -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/functionObjects/field/magSqr/magSqr.H b/src/functionObjects/field/magSqr/magSqr.H index 394700861a2..fa35957d2ef 100644 --- a/src/functionObjects/field/magSqr/magSqr.H +++ b/src/functionObjects/field/magSqr/magSqr.H @@ -33,7 +33,7 @@ Description The operation can be applied to any volume or surface field generating a volume or surface scalar field. -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/functionObjects/field/nearWallFields/nearWallFields.H b/src/functionObjects/field/nearWallFields/nearWallFields.H index 28b2ac74056..060516fa5ea 100644 --- a/src/functionObjects/field/nearWallFields/nearWallFields.H +++ b/src/functionObjects/field/nearWallFields/nearWallFields.H @@ -60,7 +60,7 @@ Usage distance | distance from patch to sample | yes | \endtable -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/functionObjects/field/pressure/pressure.H b/src/functionObjects/field/pressure/pressure.H index 59008dc48c4..0ac0cd125d4 100644 --- a/src/functionObjects/field/pressure/pressure.H +++ b/src/functionObjects/field/pressure/pressure.H @@ -104,7 +104,7 @@ Usage rhoInf | Freestream density for coefficient calculation | no | \endtable -SeeAlso +See also Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/processorField/processorField.H b/src/functionObjects/field/processorField/processorField.H index c38f0762fb7..a9f531d5edc 100644 --- a/src/functionObjects/field/processorField/processorField.H +++ b/src/functionObjects/field/processorField/processorField.H @@ -47,7 +47,7 @@ Usage type | type name: processorField | yes | \endtable -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/functionObjects/field/randomise/randomise.H b/src/functionObjects/field/randomise/randomise.H index 5d7c8b5c3f5..eec09cd4b82 100644 --- a/src/functionObjects/field/randomise/randomise.H +++ b/src/functionObjects/field/randomise/randomise.H @@ -33,7 +33,7 @@ Description The operation can be applied to any volume field. -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/functionObjects/field/readFields/readFields.H b/src/functionObjects/field/readFields/readFields.H index 1722ed40cf0..2c69d5570a0 100644 --- a/src/functionObjects/field/readFields/readFields.H +++ b/src/functionObjects/field/readFields/readFields.H @@ -53,7 +53,7 @@ Usage fields | list of fields to read | no | \endtable -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index ace7d1b5585..82250a90271 100644 --- a/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H +++ b/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H @@ -94,7 +94,7 @@ Usage coordinateSystem | transformation for vector fields | no | \endtable -SeeAlso +See also Foam::functionObject Foam::functionObjects::writeFile diff --git a/src/functionObjects/field/streamLine/streamLine.H b/src/functionObjects/field/streamLine/streamLine.H index c75edffc292..d6b21577645 100644 --- a/src/functionObjects/field/streamLine/streamLine.H +++ b/src/functionObjects/field/streamLine/streamLine.H @@ -87,7 +87,7 @@ Note When specifying the track resolution, the \c trackLength OR \c nSubCycle option should be used -SeeAlso +See also Foam::functionObject Foam::functionObjects::timeControl Foam::sampledSet diff --git a/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H b/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H index 2721b2ada17..72c16e6f41d 100644 --- a/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H +++ b/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H @@ -57,7 +57,7 @@ Usage \endtable -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::timeControl diff --git a/src/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/functionObjects/field/turbulenceFields/turbulenceFields.H index ffd988739f7..1d15fc8cce5 100644 --- a/src/functionObjects/field/turbulenceFields/turbulenceFields.H +++ b/src/functionObjects/field/turbulenceFields/turbulenceFields.H @@ -76,7 +76,7 @@ Usage devRhoReff | Divergence of the Reynolds stress \endplaintable -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::timeControl diff --git a/src/functionObjects/field/vorticity/vorticity.H b/src/functionObjects/field/vorticity/vorticity.H index 44a0b101638..250e60cb0ca 100644 --- a/src/functionObjects/field/vorticity/vorticity.H +++ b/src/functionObjects/field/vorticity/vorticity.H @@ -30,7 +30,7 @@ Group Description This function object calculates the vorticity, the curl of the velocity. -SeeAlso +See also Foam::functionObjects::fieldExpression Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index 00e87bce2b4..3aaa0e32500 100644 --- a/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H @@ -88,7 +88,7 @@ Note When specifying the track resolution, the \c trackLength OR \c nSubCycle option should be used -SeeAlso +See also Foam::functionObject Foam::functionObjects::timeControl Foam::sampledSet diff --git a/src/functionObjects/field/wallShearStress/wallShearStress.H b/src/functionObjects/field/wallShearStress/wallShearStress.H index 108eed1a671..a8ce6044ec9 100644 --- a/src/functionObjects/field/wallShearStress/wallShearStress.H +++ b/src/functionObjects/field/wallShearStress/wallShearStress.H @@ -64,7 +64,7 @@ Usage patches | list of patches to process | no | all wall patches \endtable -SeeAlso +See also Foam::functionObject Foam::functionObjects::writeFiles Foam::functionObjects::pressureTools diff --git a/src/functionObjects/field/yPlus/yPlus.H b/src/functionObjects/field/yPlus/yPlus.H index c50e310810d..45696b83000 100644 --- a/src/functionObjects/field/yPlus/yPlus.H +++ b/src/functionObjects/field/yPlus/yPlus.H @@ -31,7 +31,7 @@ Description Evaluates and outputs turbulence y+ for models. Values written to time directories as field 'yPlus' -SeeAlso +See also Foam::functionObject Foam::functionObjects::writeFiles Foam::functionObjects::timeControl diff --git a/src/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/functionObjects/forces/forceCoeffs/forceCoeffs.H index 6e4d19917d6..c663157430d 100644 --- a/src/functionObjects/forces/forceCoeffs/forceCoeffs.H +++ b/src/functionObjects/forces/forceCoeffs/forceCoeffs.H @@ -79,7 +79,7 @@ Usage cumulative | bin data accumulated with incresing distance | yes | \endtable -SeeAlso +See also Foam::functionObject Foam::functionObjects::timeControl Foam::functionObjects::forces diff --git a/src/functionObjects/forces/forces/forces.H b/src/functionObjects/forces/forces/forces.H index 2a5c70d97ca..406b6e8abb4 100644 --- a/src/functionObjects/forces/forces/forces.H +++ b/src/functionObjects/forces/forces/forces.H @@ -99,7 +99,7 @@ Note } \endverbatim -SeeAlso +See also Foam::functionObject Foam::functionObjects::writeFiles Foam::functionObjects::timeControl diff --git a/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H b/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H index 13632f9bd02..3edb64e6e91 100644 --- a/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H +++ b/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H @@ -59,7 +59,7 @@ Usage The output data of each cloud is written to a file named \<cloudName\>.dat -SeeAlso +See also Foam::functionObject Foam::functionObjects::writeFiles diff --git a/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H b/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H index a27abebdf42..a754cc659c1 100644 --- a/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H +++ b/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H @@ -60,7 +60,7 @@ Usage kinematicCloud | Name of the kinematicCloud | no | kinematicCloud \endtable -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/functionObjects/solvers/scalarTransport/scalarTransport.H b/src/functionObjects/solvers/scalarTransport/scalarTransport.H index 80267f582b6..6add280f57b 100644 --- a/src/functionObjects/solvers/scalarTransport/scalarTransport.H +++ b/src/functionObjects/solvers/scalarTransport/scalarTransport.H @@ -36,7 +36,7 @@ Description - The diffusivity can be set manually using the 'D' entry, or retrieved from the turbulence model (if applicable). -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 842eaacefd6..b79144c75c9 100644 --- a/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H +++ b/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H @@ -62,7 +62,7 @@ Description \endverbatim -SeeAlso +See also Foam::functionObject Foam::codedBase diff --git a/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H b/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H index d42297533a7..42e36ba90fd 100644 --- a/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H +++ b/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H @@ -48,7 +48,7 @@ Usage objectNames | objects to remove | yes | \endtable -SeeAlso +See also Foam::functionObject SourceFiles diff --git a/src/functionObjects/utilities/residuals/residuals.H b/src/functionObjects/utilities/residuals/residuals.H index c0902cb5cae..b6d7fbb54c5 100644 --- a/src/functionObjects/utilities/residuals/residuals.H +++ b/src/functionObjects/utilities/residuals/residuals.H @@ -49,7 +49,7 @@ Description For vector/tensor fields, e.g. U, where an equation is solved for each component, the largest residual of each component is written out. -SeeAlso +See also Foam::functionObject Foam::functionObjects::writeFiles Foam::functionObjects::timeControl diff --git a/src/functionObjects/utilities/systemCall/systemCall.H b/src/functionObjects/utilities/systemCall/systemCall.H index 0349cd1e9ca..a468b25f051 100644 --- a/src/functionObjects/utilities/systemCall/systemCall.H +++ b/src/functionObjects/utilities/systemCall/systemCall.H @@ -74,7 +74,7 @@ Note \c allowSystemOperations must be set to '1'; otherwise, system calls will not be allowed. -SeeAlso +See also Foam::functionObject Foam::functionObjects::timeControl diff --git a/src/functionObjects/utilities/writeObjects/writeObjects.H b/src/functionObjects/utilities/writeObjects/writeObjects.H index 98f7719ae13..760951f1f19 100644 --- a/src/functionObjects/utilities/writeObjects/writeObjects.H +++ b/src/functionObjects/utilities/writeObjects/writeObjects.H @@ -63,7 +63,7 @@ Usage \c exclusiveWriting disables automatic writing (i.e through database) of the objects to avoid duplicate writing. -SeeAlso +See also Foam::functionObject Foam::functionObjects::timeControl diff --git a/src/fvMotionSolver/pointPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValuePointPatchField.H b/src/fvMotionSolver/pointPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValuePointPatchField.H index 7eaaec39ee7..e1119ef29e3 100644 --- a/src/fvMotionSolver/pointPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValuePointPatchField.H +++ b/src/fvMotionSolver/pointPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValuePointPatchField.H @@ -27,7 +27,7 @@ Class Description A time-varying form of a mapped fixed value boundary condition. -See Also +See also Foam::timeVaryingMappedFixedValueFvPatchField SourceFiles diff --git a/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H b/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H index 4fc55ea5aa8..72ed262638a 100644 --- a/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H +++ b/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H @@ -47,7 +47,7 @@ Description } \endverbatim -SeeAlso +See also Foam::fvOption SourceFiles diff --git a/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H b/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H index f3652da1dc8..87c6673a8c6 100644 --- a/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H +++ b/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H @@ -87,7 +87,7 @@ Usage - local : use local flow conditions - surfaceNormal : specified normal velocity (positive towards rotor) -See Also +See also Foam::bladeModel Foam::lookupProfile Foam::seriesProfile diff --git a/src/fvOptions/sources/general/semiImplicitSource/SemiImplicitSource.H b/src/fvOptions/sources/general/semiImplicitSource/SemiImplicitSource.H index 7255dcad990..c6bf7ff7778 100644 --- a/src/fvOptions/sources/general/semiImplicitSource/SemiImplicitSource.H +++ b/src/fvOptions/sources/general/semiImplicitSource/SemiImplicitSource.H @@ -57,7 +57,7 @@ Description - absolute: values are given as \<quantity\> - specific: values are given as \<quantity\>/m3 -SeeAlso +See also Foam::fvOption SourceFiles diff --git a/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H b/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H index ec3be385b42..b370c362bd3 100644 --- a/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H +++ b/src/genericPatchFields/genericFvPatchField/genericFvPatchField.H @@ -29,7 +29,7 @@ Description condition, useful as a fallback for handling unknown patch types. Not generally applicable as a user-specified condition. -SeeAlso +See also Foam::calculatedFvPatchField SourceFiles diff --git a/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H b/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H index 3304802cae3..da3467b487f 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H +++ b/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H @@ -42,7 +42,7 @@ Description SAE Technical Paper Series @endverbatim -See Also +See also The TAB model \*---------------------------------------------------------------------------*/ diff --git a/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H b/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H index 55c1e1b16db..1db3b8c7818 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H +++ b/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H @@ -38,7 +38,7 @@ Description This implementation follows the kiva version. -See Also +See also The Enhanced %TAB model - ETAB \*---------------------------------------------------------------------------*/ diff --git a/src/mesh/blockMesh/curvedEdges/BSpline.H b/src/mesh/blockMesh/curvedEdges/BSpline.H index 2e4efa27197..116fba67daa 100644 --- a/src/mesh/blockMesh/curvedEdges/BSpline.H +++ b/src/mesh/blockMesh/curvedEdges/BSpline.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -49,7 +49,7 @@ Description A future implementation could also handle closed splines. -SeeAlso +See also CatmullRomSpline SourceFiles diff --git a/src/mesh/blockMesh/curvedEdges/CatmullRomSpline.H b/src/mesh/blockMesh/curvedEdges/CatmullRomSpline.H index 4d69a132955..fda446f44fd 100644 --- a/src/mesh/blockMesh/curvedEdges/CatmullRomSpline.H +++ b/src/mesh/blockMesh/curvedEdges/CatmullRomSpline.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -50,7 +50,7 @@ Description A future implementation could also handle closed splines. -SeeAlso +See also http://www.algorithmist.net/catmullrom.html provides a nice introduction diff --git a/src/mesh/extrudeModel/cyclicSector/cyclicSector.H b/src/mesh/extrudeModel/cyclicSector/cyclicSector.H index 590b923b017..86d99e13859 100644 --- a/src/mesh/extrudeModel/cyclicSector/cyclicSector.H +++ b/src/mesh/extrudeModel/cyclicSector/cyclicSector.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description Extrudes a sector. -SeeAlso +See also Foam::extrudeModels::sector \*---------------------------------------------------------------------------*/ diff --git a/src/mesh/extrudeModel/planeExtrusion/planeExtrusion.H b/src/mesh/extrudeModel/planeExtrusion/planeExtrusion.H index 9fea06cf2c7..06498201699 100644 --- a/src/mesh/extrudeModel/planeExtrusion/planeExtrusion.H +++ b/src/mesh/extrudeModel/planeExtrusion/planeExtrusion.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -28,7 +28,7 @@ Description Extrudes by transforming points normal to the surface by 1 layer over a given distance. -SeeAlso +See also Foam::extrudeModels::linearNormal \*---------------------------------------------------------------------------*/ diff --git a/src/mesh/extrudeModel/wedge/wedge.H b/src/mesh/extrudeModel/wedge/wedge.H index cbd262a5cc4..434057589c6 100644 --- a/src/mesh/extrudeModel/wedge/wedge.H +++ b/src/mesh/extrudeModel/wedge/wedge.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description Extrudes by rotating a surface symmetrically around axis by 1 layer. -SeeAlso +See also Foam::extrudeModels::sector \*---------------------------------------------------------------------------*/ diff --git a/src/meshTools/cellDist/patchWave/patchDataWave.H b/src/meshTools/cellDist/patchWave/patchDataWave.H index a155d1ec34d..51c95afdbd7 100644 --- a/src/meshTools/cellDist/patchWave/patchDataWave.H +++ b/src/meshTools/cellDist/patchWave/patchDataWave.H @@ -31,7 +31,7 @@ Description (like patchWave), but also additional transported data. It is used, for example, in the y+ calculation. -See Also +See also The patchWave class. SourceFiles diff --git a/src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.H b/src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.H index 1465ff2daab..5ff4d47e847 100644 --- a/src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.H +++ b/src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.H @@ -40,7 +40,7 @@ Description - %r gets replaced by current processor rank - it will decompose into 2 domains -SeeAlso +See also Foam::scotchDecomp SourceFiles diff --git a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.H b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.H index 9e1ed0f978d..6375c32c863 100644 --- a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.H +++ b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.H @@ -70,7 +70,7 @@ Description - Qr is the radiative flux defined in the radiation model. -SeeAlso +See also Foam::temperatureCoupledBase SourceFiles diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H index bb25db99c9b..33f2404f41b 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H @@ -68,7 +68,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H index 526cea3ef60..34089629aa7 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H @@ -58,7 +58,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H index 7e43fc89bf1..a26f42095a5 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H @@ -43,7 +43,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::nutkWallFunctionFvPatchScalarField SourceFiles diff --git a/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H b/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H index 0efbceb2604..be080f831db 100644 --- a/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H +++ b/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H @@ -149,7 +149,7 @@ Usage \endverbatim -SeeAlso +See also Foam::compressible::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField Foam::regionModels::thermalBaffleModels::thermalBaffleModel diff --git a/src/rigidBodyDynamics/rigidBodySolvers/CrankNicolson/CrankNicolson.H b/src/rigidBodyDynamics/rigidBodySolvers/CrankNicolson/CrankNicolson.H index 0aa3a387ab5..35aae2d54a2 100644 --- a/src/rigidBodyDynamics/rigidBodySolvers/CrankNicolson/CrankNicolson.H +++ b/src/rigidBodyDynamics/rigidBodySolvers/CrankNicolson/CrankNicolson.H @@ -43,7 +43,7 @@ Description } \endverbatim -SeeAlso +See also Foam::RBD::rigidBodySolvers::Newmark SourceFiles diff --git a/src/rigidBodyDynamics/rigidBodySolvers/symplectic/symplectic.H b/src/rigidBodyDynamics/rigidBodySolvers/symplectic/symplectic.H index ec3f91d0484..225dea64594 100644 --- a/src/rigidBodyDynamics/rigidBodySolvers/symplectic/symplectic.H +++ b/src/rigidBodyDynamics/rigidBodySolvers/symplectic/symplectic.H @@ -47,7 +47,7 @@ Description } \endverbatim -SeeAlso +See also Foam::RBD::rigidBodySolvers::CrankNicolson Foam::RBD::rigidBodySolvers::Newmark diff --git a/src/sampling/meshToMesh/meshToMesh.H b/src/sampling/meshToMesh/meshToMesh.H index 84e24bbdef0..6d5e5cd058b 100644 --- a/src/sampling/meshToMesh/meshToMesh.H +++ b/src/sampling/meshToMesh/meshToMesh.H @@ -29,7 +29,7 @@ Description Mapping is performed using a run-time selectable interpolation mothod -SeeAlso +See also meshToMeshMethod SourceFiles diff --git a/src/sixDoFRigidBodyMotion/sixDoFSolvers/CrankNicolson/CrankNicolson.H b/src/sixDoFRigidBodyMotion/sixDoFSolvers/CrankNicolson/CrankNicolson.H index a8dd2ccbff3..b340a81415e 100644 --- a/src/sixDoFRigidBodyMotion/sixDoFSolvers/CrankNicolson/CrankNicolson.H +++ b/src/sixDoFRigidBodyMotion/sixDoFSolvers/CrankNicolson/CrankNicolson.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -43,7 +43,7 @@ Description } \endverbatim -SeeAlso +See also Foam::sixDoFSolvers::Newmark SourceFiles diff --git a/src/sixDoFRigidBodyMotion/sixDoFSolvers/symplectic/symplectic.H b/src/sixDoFRigidBodyMotion/sixDoFSolvers/symplectic/symplectic.H index d03b77bbd59..680a1704e55 100644 --- a/src/sixDoFRigidBodyMotion/sixDoFSolvers/symplectic/symplectic.H +++ b/src/sixDoFRigidBodyMotion/sixDoFSolvers/symplectic/symplectic.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -47,7 +47,7 @@ Description } \endverbatim -SeeAlso +See also Foam::sixDoFSolvers::CrankNicolson Foam::sixDoFSolvers::Newmark diff --git a/src/surfMesh/UnsortedMeshedSurface/UnsortedMeshedSurface.H b/src/surfMesh/UnsortedMeshedSurface/UnsortedMeshedSurface.H index 52cbddd3bc2..32cf8e77733 100644 --- a/src/surfMesh/UnsortedMeshedSurface/UnsortedMeshedSurface.H +++ b/src/surfMesh/UnsortedMeshedSurface/UnsortedMeshedSurface.H @@ -34,7 +34,7 @@ Description many be adjusted in an arbitrary manner without worrying about needed to adjust the zone information (eg, surface refinement). -See Also +See also The Foam::MeshedSurface - which is organized as a surface mesh, but with independent zone information. diff --git a/src/surfMesh/surfaceFormats/off/OFFsurfaceFormat.H b/src/surfMesh/surfaceFormats/off/OFFsurfaceFormat.H index d861a92a6d5..0fc6bdf6c67 100644 --- a/src/surfMesh/surfaceFormats/off/OFFsurfaceFormat.H +++ b/src/surfMesh/surfaceFormats/off/OFFsurfaceFormat.H @@ -28,7 +28,7 @@ Description Provide a means of reading/writing Geomview OFF polyList format. -See Also +See also The <a href="http://www.geoview.org">Geoview</a> file format information: http://www.geomview.org/docs/html/OFF.html#OFF diff --git a/src/surfMesh/surfaceFormats/smesh/SMESHsurfaceFormat.H b/src/surfMesh/surfaceFormats/smesh/SMESHsurfaceFormat.H index cd00d23e8f3..94fd8e1df0d 100644 --- a/src/surfMesh/surfaceFormats/smesh/SMESHsurfaceFormat.H +++ b/src/surfMesh/surfaceFormats/smesh/SMESHsurfaceFormat.H @@ -29,7 +29,7 @@ Description Tetgen http://tetgen.berlios.de -See Also +See also File format information: http://tetgen.berlios.de/fformats.smesh.html diff --git a/src/surfMesh/surfaceFormats/starcd/STARCDsurfaceFormat.H b/src/surfMesh/surfaceFormats/starcd/STARCDsurfaceFormat.H index 12093d490b7..8e4c7e09413 100644 --- a/src/surfMesh/surfaceFormats/starcd/STARCDsurfaceFormat.H +++ b/src/surfMesh/surfaceFormats/starcd/STARCDsurfaceFormat.H @@ -30,7 +30,7 @@ Description Note Uses the extension \a .inp (input) to denote the format. -See Also +See also Foam::meshReaders::STARCD SourceFiles diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJump/energyJumpFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJump/energyJumpFvPatchScalarField.H index 44c95ab72bc..71556d2d13e 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJump/energyJumpFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJump/energyJumpFvPatchScalarField.H @@ -32,7 +32,7 @@ Description of coupled patches. It is not applied directly, but is employed on-the-fly when converting temperature boundary conditions into energy. -SeeAlso +See also Foam::fixedJumpFvPatchField SourceFiles diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpAMI/energyJumpAMIFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpAMI/energyJumpAMIFvPatchScalarField.H index 517c29c130a..4a2bef0eef5 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpAMI/energyJumpAMIFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpAMI/energyJumpAMIFvPatchScalarField.H @@ -33,7 +33,7 @@ Description applied directly, but is employed on-the-fly when converting temperature boundary conditions into energy. -SeeAlso +See also Foam::fixedJumpAMIFvPatchField SourceFiles diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H index 51e51d2858f..593cf50117c 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H @@ -41,7 +41,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedValueFvPatchField SourceFiles diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H index c0957fb1d5b..a2f83f01d4a 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H @@ -56,7 +56,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::fixedGradientFvPatchField SourceFiles diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/mixedEnergy/mixedEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/mixedEnergy/mixedEnergyFvPatchScalarField.H index 97c55cbd1eb..adb38f0cebd 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/mixedEnergy/mixedEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/mixedEnergy/mixedEnergyFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Group Description This boundary condition provides a mixed condition for internal energy -SeeAlso +See also Foam::mixedFvPatchField SourceFiles diff --git a/src/thermophysicalModels/properties/liquidMixtureProperties/liquidMixtureProperties/liquidMixtureProperties.H b/src/thermophysicalModels/properties/liquidMixtureProperties/liquidMixtureProperties/liquidMixtureProperties.H index a88476ea986..dd276a25472 100644 --- a/src/thermophysicalModels/properties/liquidMixtureProperties/liquidMixtureProperties/liquidMixtureProperties.H +++ b/src/thermophysicalModels/properties/liquidMixtureProperties/liquidMixtureProperties/liquidMixtureProperties.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -49,7 +49,7 @@ Description SourceFiles liquidMixtureProperties.C -SeeAlso +See also Foam::liquidProperties \*---------------------------------------------------------------------------*/ diff --git a/src/thermophysicalModels/properties/solidMixtureProperties/solidMixtureProperties/solidMixtureProperties.H b/src/thermophysicalModels/properties/solidMixtureProperties/solidMixtureProperties/solidMixtureProperties.H index 52b6134ec80..ed0aad5bfaa 100644 --- a/src/thermophysicalModels/properties/solidMixtureProperties/solidMixtureProperties/solidMixtureProperties.H +++ b/src/thermophysicalModels/properties/solidMixtureProperties/solidMixtureProperties/solidMixtureProperties.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -50,7 +50,7 @@ Description SourceFiles solidMixtureProperties.C -SeeAlso +See also Foam::solidProperties \*---------------------------------------------------------------------------*/ diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H index a743d9e6e42..f4bac96319b 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H @@ -51,7 +51,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::radiationCoupledBase Foam::mixedFvPatchField diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H index 540e1509335..c1a19844296 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H @@ -51,7 +51,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::radiationCoupledBase Foam::mixedFvPatchField diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H index f5686774244..03ab4829b53 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H @@ -52,7 +52,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::radiationCoupledBase Foam::radiation::radiationModel Foam::radiation::fvDOM diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H index 1325c5e412d..85da20c9e93 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H @@ -50,7 +50,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::radiationCoupledBase Foam::radiation::radiationModel Foam::radiation::viewFactor diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H index 25b6a487189..f1a6905d40b 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H @@ -47,7 +47,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::mixedFvPatchScalarField Foam::radiationCoupledBase diff --git a/src/thermophysicalModels/reactionThermo/functionObjects/moleFractions/moleFractions.H b/src/thermophysicalModels/reactionThermo/functionObjects/moleFractions/moleFractions.H index 4298481f2f8..ce8781a5ad4 100644 --- a/src/thermophysicalModels/reactionThermo/functionObjects/moleFractions/moleFractions.H +++ b/src/thermophysicalModels/reactionThermo/functionObjects/moleFractions/moleFractions.H @@ -48,7 +48,7 @@ Description \endverbatim depending on the thermodynamics package used in the solver. -SeeAlso +See also Foam::functionObjects::fvMeshFunctionObject SourceFiles diff --git a/src/transportModels/twoPhaseProperties/alphaContactAngle/constantAlphaContactAngle/constantAlphaContactAngleFvPatchScalarField.H b/src/transportModels/twoPhaseProperties/alphaContactAngle/constantAlphaContactAngle/constantAlphaContactAngleFvPatchScalarField.H index 7ce340390e6..81518b53bca 100644 --- a/src/transportModels/twoPhaseProperties/alphaContactAngle/constantAlphaContactAngle/constantAlphaContactAngleFvPatchScalarField.H +++ b/src/transportModels/twoPhaseProperties/alphaContactAngle/constantAlphaContactAngle/constantAlphaContactAngleFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description A constant alphaContactAngle scalar boundary condition. -SeeAlso +See also Foam::alphaContactAngleFvPatchScalarField Foam::temperatureDependentAlphaContactAngleFvPatchScalarField diff --git a/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H b/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H index e97c80e5b45..fa45c25ecc1 100644 --- a/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H +++ b/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H @@ -44,7 +44,7 @@ Usage } \endverbatim -SeeAlso +See also Foam::alphaContactAngleFvPatchScalarField Foam::constantAlphaContactAngleFvPatchScalarField -- GitLab