src/finiteVolume: Moved function documentation comments into .H files and removed duplicates

This commit is contained in:
Henry Weller
2016-02-29 19:58:50 +00:00
parent 8b9fd56439
commit 1317a716e1
26 changed files with 82 additions and 90 deletions

View File

@ -67,7 +67,6 @@ Foam::processorFvPatchField<Type>::processorFvPatchField
{}
// Construct by mapping given processorFvPatchField<Type>
template<class Type>
Foam::processorFvPatchField<Type>::processorFvPatchField
(

View File

@ -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
@ -50,13 +50,11 @@ Foam::processorCyclicFvPatchField<Type>::processorCyclicFvPatchField
const Field<Type>& f
)
:
//coupledFvPatchField<Type>(p, iF, f),
processorFvPatchField<Type>(p, iF, f),
procPatch_(refCast<const processorCyclicFvPatch>(p))
{}
// Construct by mapping given processorCyclicFvPatchField<Type>
template<class Type>
Foam::processorCyclicFvPatchField<Type>::processorCyclicFvPatchField
(
@ -66,7 +64,6 @@ Foam::processorCyclicFvPatchField<Type>::processorCyclicFvPatchField
const fvPatchFieldMapper& mapper
)
:
//coupledFvPatchField<Type>(ptf, p, iF, mapper),
processorFvPatchField<Type>(ptf, p, iF, mapper),
procPatch_(refCast<const processorCyclicFvPatch>(p))
{
@ -90,7 +87,6 @@ Foam::processorCyclicFvPatchField<Type>::processorCyclicFvPatchField
const dictionary& dict
)
:
//coupledFvPatchField<Type>(p, iF, dict),
processorFvPatchField<Type>(p, iF, dict),
procPatch_(refCast<const processorCyclicFvPatch>(p))
{
@ -122,8 +118,6 @@ Foam::processorCyclicFvPatchField<Type>::processorCyclicFvPatchField
const processorCyclicFvPatchField<Type>& ptf
)
:
//processorLduInterfaceField(),
//coupledFvPatchField<Type>(ptf),
processorFvPatchField<Type>(ptf),
procPatch_(refCast<const processorCyclicFvPatch>(ptf.patch()))
{}
@ -136,7 +130,6 @@ Foam::processorCyclicFvPatchField<Type>::processorCyclicFvPatchField
const DimensionedField<Type, volMesh>& iF
)
:
//coupledFvPatchField<Type>(ptf, iF),
processorFvPatchField<Type>(ptf, iF),
procPatch_(refCast<const processorCyclicFvPatch>(ptf.patch()))
{}

View File

@ -558,7 +558,6 @@ void Foam::fvPatchField<Type>::operator/=
}
// Force an assignment, overriding fixedValue status
template<class Type>
void Foam::fvPatchField<Type>::operator==
(

View File

@ -53,7 +53,6 @@ Foam::extendedCentredCellToCellStencil::extendedCentredCellToCellStencil
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
// Per cell which elements of the stencil to keep.
void Foam::extendedCentredCellToCellStencil::compact()
{
boolList isInStencil(map().constructSize(), false);

View File

@ -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
@ -29,7 +29,6 @@ License
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// Calculates per edge the neighbour data (= edgeCells)
void Foam::CECCellToCellStencil::calcEdgeBoundaryData
(
const boolList& isValidBFace,
@ -61,8 +60,6 @@ void Foam::CECCellToCellStencil::calcEdgeBoundaryData
}
// Calculates per cell the neighbour data (= cell or boundary in global
// numbering). First element is always cell itself!
void Foam::CECCellToCellStencil::calcCellStencil
(
labelListList& globalCellCells

View File

@ -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
@ -63,6 +63,9 @@ class CECCellToCellStencil
EdgeMap<labelList>& neiGlobal
) const;
//- Calculates per cell the neighbour data
// (= cell or boundary in global numbering).
// First element is always cell itself!
void calcCellStencil(labelListList& globalCellCells) const;

View File

@ -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,6 @@ License
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// Calculates per face the neighbour data (= cell or boundary face)
void Foam::CFCCellToCellStencil::calcFaceBoundaryData
(
labelList& neiGlobal
@ -82,10 +81,10 @@ void Foam::CFCCellToCellStencil::calcFaceBoundaryData
}
// Calculates per cell the neighbour data (= cell or boundary in global
// numbering). First element is always cell itself!
void Foam::CFCCellToCellStencil::calcCellStencil(labelListList& globalCellCells)
const
void Foam::CFCCellToCellStencil::calcCellStencil
(
labelListList& globalCellCells
) const
{
const label nBnd = mesh().nFaces()-mesh().nInternalFaces();
const labelList& own = mesh().faceOwner();

View File

@ -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
@ -51,8 +51,12 @@ class CFCCellToCellStencil
{
// Private Member Functions
//- Calculates per face the neighbour data (= cell or boundary face)
void calcFaceBoundaryData(labelList& neiGlobal) const;
//- Calculates per cell the neighbour data
// (= cell or boundary in global numbering).
// First element is always cell itself!
void calcCellStencil(labelListList& globalCellCells) const;

View File

@ -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
@ -29,7 +29,6 @@ License
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// Calculates per point the neighbour data (= pointCells)
void Foam::CPCCellToCellStencil::calcPointBoundaryData
(
const boolList& isValidBFace,
@ -67,8 +66,6 @@ void Foam::CPCCellToCellStencil::calcPointBoundaryData
}
// Calculates per cell the neighbour data (= cell or boundary in global
// numbering). First element is always cell itself!
void Foam::CPCCellToCellStencil::calcCellStencil
(
labelListList& globalCellCells

View File

@ -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
@ -62,6 +62,9 @@ class CPCCellToCellStencil
Map<labelList>& neiGlobal
) const;
//- Calculates per cell the neighbour data
// (= cell or boundary in global numbering).
// First element is always cell itself!
void calcCellStencil(labelListList& globalCellCells) const;

View File

@ -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,6 @@ License
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// Merge two list and guarantee global0,global1 are first.
void Foam::cellToCellStencil::merge
(
const label global0,
@ -131,7 +130,6 @@ void Foam::cellToCellStencil::merge
}
// Merge two list and guarantee globalI is first.
void Foam::cellToCellStencil::merge
(
const label globalI,

View File

@ -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
@ -67,16 +67,22 @@ class cellToCellStencil
protected:
//- Merge two lists.
// Guarantee global0, global1 are first.
static void merge
(
const label,
const label,
const labelList&,
labelList&
const label global0,
const label global1,
const labelList& listA,
labelList& listB
);
//- Merge two lists.
static void merge(const label, const labelList&, labelList&);
//- Merge two lists and guarantee globalI is first.
static void merge
(
const label globalI,
const labelList& pGlobals,
labelList& cCells
);
//- Valid boundary faces (not empty and not coupled)
void validBoundaryFaces(boolList& isValidBFace) const;

View File

@ -53,9 +53,10 @@ Foam::extendedCentredCellToFaceStencil::extendedCentredCellToFaceStencil
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
// Per face which elements of the stencil to keep.
void Foam::extendedCentredCellToFaceStencil::compact()
{
// Per face which elements of the stencil to keep.
boolList isInStencil(map().constructSize(), false);
forAll(stencil_, faceI)

View File

@ -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,6 @@ License
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// Calculates per edge the neighbour data (= edgeCells)
void Foam::FECCellToFaceStencil::calcEdgeBoundaryData
(
const boolList& isValidBFace,
@ -62,8 +61,6 @@ void Foam::FECCellToFaceStencil::calcEdgeBoundaryData
}
// Calculates per face the edge connected data (= cell or boundary in global
// numbering).
void Foam::FECCellToFaceStencil::calcFaceStencil
(
labelListList& faceStencil

View File

@ -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
@ -61,6 +61,8 @@ class FECCellToFaceStencil
EdgeMap<labelList>& neiGlobal
) const;
//- Calculates per face the edge connected data
// (= cell or boundary in global numbering).
void calcFaceStencil(labelListList& faceStencil) const;

View File

@ -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
@ -31,7 +31,6 @@ License
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// Merge two list and guarantee global0,global1 are first.
void Foam::cellToFaceStencil::merge
(
const label global0,
@ -132,7 +131,6 @@ void Foam::cellToFaceStencil::merge
}
// Merge two list and guarantee globalI is first.
void Foam::cellToFaceStencil::merge
(
const label globalI,
@ -338,13 +336,14 @@ Foam::labelList Foam::cellToFaceStencil::calcFaceCells
}
// Calculates per face a list of global cell/face indices.
void Foam::cellToFaceStencil::calcFaceStencil
(
const labelListList& globalCellCells,
labelListList& faceStencil
) const
{
// Calculates per face a list of global cell/face indices.
const polyBoundaryMesh& patches = mesh_.boundaryMesh();
const label nBnd = mesh_.nFaces()-mesh_.nInternalFaces();
const labelList& own = mesh_.faceOwner();

View File

@ -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
@ -67,16 +67,22 @@ class cellToFaceStencil
protected:
//- Merge two lists.
// Guarantee global0, global1 are first.
static void merge
(
const label,
const label,
const labelList&,
labelList&
const label global0,
const label global1,
const labelList& listA,
labelList& listB
);
//- Merge two lists.
static void merge(const label, const labelList&, labelList&);
//- Merge two lists and guarantee globalI is first.
static void merge
(
const label globalI,
const labelList& pGlobals,
labelList& cCells
);
//- Valid boundary faces (not empty and not coupled)
void validBoundaryFaces(boolList& isValidBFace) const;

View File

@ -53,7 +53,6 @@ Foam::extendedCentredFaceToCellStencil::extendedCentredFaceToCellStencil
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
// Per face which elements of the stencil to keep.
void Foam::extendedCentredFaceToCellStencil::compact()
{
boolList isInStencil(map().constructSize(), false);

View File

@ -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,8 +30,6 @@ License
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// Calculates per face the neighbour data (= faces of cell). Leaves out the
// face itself since this is already in stencil.
void Foam::CFCFaceToCellStencil::calcFaceBoundaryData
(
labelListList& neiGlobal
@ -81,7 +79,7 @@ void Foam::CFCFaceToCellStencil::calcFaceBoundaryData
// Do nothing since face itself already in stencil
}
}
//syncTools::swapBoundaryFaceList(mesh(), neiGlobal);
syncTools::syncBoundaryFaceList
(
mesh(),
@ -92,10 +90,10 @@ void Foam::CFCFaceToCellStencil::calcFaceBoundaryData
}
// Calculates per cell the neighbour data (= cell or boundary in global
// numbering). First element is always cell itself!
void Foam::CFCFaceToCellStencil::calcCellStencil(labelListList& globalCellFaces)
const
void Foam::CFCFaceToCellStencil::calcCellStencil
(
labelListList& globalCellFaces
) const
{
const label nBnd = mesh().nFaces()-mesh().nInternalFaces();
const labelList& own = mesh().faceOwner();

View File

@ -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
@ -51,8 +51,13 @@ class CFCFaceToCellStencil
{
// Private Member Functions
//- Calculates per face the neighbour data (= faces of cell).
// Leaves out the face itself since this is already in stencil.
void calcFaceBoundaryData(labelListList& neiGlobal) const;
//- Calculates per cell the neighbour data
// (= cell or boundary in global numbering).
// First element is always cell itself!
void calcCellStencil(labelListList& globalCellFaces) const;

View File

@ -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
@ -156,14 +156,6 @@ void Foam::fvPatchMapper::calcAddressing() const
}
}
//// Cater for bad mapping
//if (nActive == 0)
//{
// newAddr[nActive] = 0;
// newWeights[nActive] = 1;
// nActive++;
//}
newAddr.setSize(nActive);
newWeights.setSize(nActive);
@ -211,7 +203,6 @@ void Foam::fvPatchMapper::clearOut()
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
// Construct from components
Foam::fvPatchMapper::fvPatchMapper
(
const fvPatch& patch,

View File

@ -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
@ -144,7 +144,6 @@ void Foam::fvSurfaceMapper::clearOut()
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
// Construct from components
Foam::fvSurfaceMapper::fvSurfaceMapper
(
const fvMesh& mesh,

View File

@ -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
@ -87,14 +87,15 @@ void Foam::fvMeshSubset::markPoints
}
// Synchronize nCellsUsingFace on both sides of coupled patches. Marks
// faces that become 'uncoupled' with 3.
void Foam::fvMeshSubset::doCoupledPatches
(
const bool syncPar,
labelList& nCellsUsingFace
) const
{
// Synchronize nCellsUsingFace on both sides of coupled patches.
// Marks faces that become 'uncoupled' with 3.
const polyBoundaryMesh& oldPatches = baseMesh().boundaryMesh();
label nUncoupled = 0;
@ -355,7 +356,6 @@ void Foam::fvMeshSubset::subsetZones()
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
// Construct from components
Foam::fvMeshSubset::fvMeshSubset(const fvMesh& baseMesh)
:
baseMesh_(baseMesh),

View File

@ -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
@ -29,16 +29,17 @@ License
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// Conversion is a two step process:
// - from original (fine) patch faces to agglomerations (aggloms might not
// be in correct patch order)
// - from agglomerations to coarse patch faces
void Foam::singleCellFvMesh::agglomerateMesh
(
const fvMesh& mesh,
const labelListList& agglom
)
{
// Conversion is a two step process:
// - from original (fine) patch faces to agglomerations (aggloms might not
// be in correct patch order)
// - from agglomerations to coarse patch faces
const polyBoundaryMesh& oldPatches = mesh.boundaryMesh();
// Check agglomeration within patch face range and continuous

View File

@ -30,7 +30,6 @@ License
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
// Construct from components
template<class TransferType>
Foam::wallDistData<TransferType>::wallDistData
(
@ -68,7 +67,6 @@ Foam::wallDistData<TransferType>::~wallDistData()
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
// Correct for mesh geom/topo changes
template<class TransferType>
void Foam::wallDistData<TransferType>::correct()
{

View File

@ -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
@ -121,7 +121,6 @@ Foam::surfaceInterpolation::nonOrthCorrectionVectors() const
}
// Do what is neccessary if the mesh has moved
bool Foam::surfaceInterpolation::movePoints()
{
deleteDemandDrivenData(weights_);