STYLE: finiteArea doc and style updates

This commit is contained in:
Andrew Heather
2017-12-18 11:25:53 +00:00
parent 00a8c8bc5f
commit 22e0a05e8b
6 changed files with 51 additions and 33 deletions

View File

@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation | Copyright (C) 2017 OpenCFD Ltd.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
This file is part of OpenFOAM. This file is part of OpenFOAM.
@ -39,6 +39,7 @@ The available solvers are grouped into the following categories:
- \ref grpLagrangianSolvers - \ref grpLagrangianSolvers
- \ref grpMultiphaseSolvers - \ref grpMultiphaseSolvers
- \ref grpStressAnalysisSolvers - \ref grpStressAnalysisSolvers
- \ref grpFiniteAreaSolvers
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

View File

@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation | Copyright (C) 2017 OpenCFD Ltd.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
This file is part of OpenFOAM. This file is part of OpenFOAM.
@ -34,4 +34,10 @@ License
This group contains moving mesh solvers solvers This group contains moving mesh solvers solvers
@} @}
\defgroup grpFiniteAreaSolvers Finite area solvers
@{
\ingroup grpSolvers
This group contains finite area solvers
@}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

View File

@ -26,6 +26,9 @@ License
Application Application
liquidFilmFoam liquidFilmFoam
Group
grpFiniteAreaSolvers
Description Description
Transient solver for incompressible, laminar flow of Newtonian fluids in Transient solver for incompressible, laminar flow of Newtonian fluids in
liquid film formulation. liquid film formulation.
@ -148,6 +151,8 @@ int main(int argc, char *argv[])
<< nl << endl; << nl << endl;
} }
Info<< "End\n" << endl;
return 0; return 0;
} }

View File

@ -26,6 +26,9 @@ License
Application Application
surfactantFoam for sphere transport surfactantFoam for sphere transport
Group
grpFiniteAreaSolvers
Description Description
Passive scalar transport equation solver on a sphere Passive scalar transport equation solver on a sphere
@ -64,7 +67,7 @@ int main(int argc, char *argv[])
CsEqn.solve(); CsEqn.solve();
if (runTime.outputTime()) if (runTime.writeTime())
{ {
vsm.mapToVolume(Cs, Cvf.boundaryFieldRef()); vsm.mapToVolume(Cs, Cvf.boundaryFieldRef());
@ -79,6 +82,8 @@ int main(int argc, char *argv[])
<< nl << endl; << nl << endl;
} }
Info<< "End\n" << endl;
return 0; return 0;
} }

View File

@ -27,7 +27,7 @@ Application
surfactantFoam surfactantFoam
Group Group
grpBasicSolvers grpFiniteAreaSolvers
Description Description
Passive scalar transport equation solver. Passive scalar transport equation solver.
@ -90,7 +90,7 @@ int main(int argc, char *argv[])
CsEqn.solve(); CsEqn.solve();
if (runTime.outputTime()) if (runTime.writeTime())
{ {
vsm.mapToVolume(Cs, Cvf.boundaryFieldRef()); vsm.mapToVolume(Cs, Cvf.boundaryFieldRef());
@ -105,6 +105,8 @@ int main(int argc, char *argv[])
<< nl << endl; << nl << endl;
} }
Info<< "End\n" << endl;
return 0; return 0;
} }

View File

@ -69,11 +69,12 @@ public:
int main(int argc, char *argv[]) int main(int argc, char *argv[])
{ {
# include "addRegionOption.H" #include "addRegionOption.H"
argList::noParallel();
# include "setRootCase.H" #include "setRootCase.H"
# include "createTime.H" #include "createTime.H"
# include "createNamedMesh.H" #include "createNamedMesh.H"
// Reading faMeshDefinition dictionary // Reading faMeshDefinition dictionary
IOdictionary faMeshDefinition IOdictionary faMeshDefinition
@ -94,40 +95,38 @@ int main(int argc, char *argv[])
faMeshDefinition.lookup("polyMeshPatches") faMeshDefinition.lookup("polyMeshPatches")
); );
dictionary bndDict = faMeshDefinition.subDict("boundary"); const dictionary& bndDict = faMeshDefinition.subDict("boundary");
wordList faPatchNames = bndDict.toc(); const wordList faPatchNames(bndDict.toc());
List<faPatchData> faPatches(faPatchNames.size()+1); List<faPatchData> faPatches(faPatchNames.size()+1);
forAll (faPatchNames, patchI) forAll(faPatchNames, patchI)
{ {
dictionary curPatchDict = const dictionary& curPatchDict = bndDict.subDict(faPatchNames[patchI]);
bndDict.subDict(faPatchNames[patchI]);
faPatches[patchI].name_ = faPatchNames[patchI]; faPatches[patchI].name_ = faPatchNames[patchI];
faPatches[patchI].type_ = faPatches[patchI].type_ = word(curPatchDict.lookup("type"));
word(curPatchDict.lookup("type"));
word ownName = curPatchDict.lookup("ownerPolyPatch"); const word ownName = curPatchDict.lookup("ownerPolyPatch");
faPatches[patchI].ownPolyPatchID_ = faPatches[patchI].ownPolyPatchID_ =
mesh.boundaryMesh().findPatchID(ownName); mesh.boundaryMesh().findPatchID(ownName);
if ( faPatches[patchI].ownPolyPatchID_ < 0 ) if (faPatches[patchI].ownPolyPatchID_ < 0)
{ {
FatalErrorIn("makeFaMesh:") FatalErrorIn("makeFaMesh:")
<< "neighbourPolyPatch " << ownName << " does not exist" << "neighbourPolyPatch " << ownName << " does not exist"
<< exit(FatalError); << exit(FatalError);
} }
word neiName = curPatchDict.lookup("neighbourPolyPatch"); const word neiName = curPatchDict.lookup("neighbourPolyPatch");
faPatches[patchI].ngbPolyPatchID_ = faPatches[patchI].ngbPolyPatchID_ =
mesh.boundaryMesh().findPatchID(neiName); mesh.boundaryMesh().findPatchID(neiName);
if ( faPatches[patchI].ngbPolyPatchID_ < 0 ) if (faPatches[patchI].ngbPolyPatchID_ < 0)
{ {
FatalErrorIn("makeFaMesh:") FatalErrorIn("makeFaMesh:")
<< "neighbourPolyPatch " << neiName << " does not exist" << "neighbourPolyPatch " << neiName << " does not exist"
@ -140,12 +139,12 @@ int main(int argc, char *argv[])
labelList patchIDs(polyMeshPatches.size(), -1); labelList patchIDs(polyMeshPatches.size(), -1);
forAll (polyMeshPatches, patchI) forAll(polyMeshPatches, patchI)
{ {
patchIDs[patchI] = patchIDs[patchI] =
mesh.boundaryMesh().findPatchID(polyMeshPatches[patchI]); mesh.boundaryMesh().findPatchID(polyMeshPatches[patchI]);
if ( patchIDs[patchI] < 0 ) if (patchIDs[patchI] < 0)
{ {
FatalErrorIn("makeFaMesh:") FatalErrorIn("makeFaMesh:")
<< "Patch " << polyMeshPatches[patchI] << " does not exist" << "Patch " << polyMeshPatches[patchI] << " does not exist"
@ -163,13 +162,13 @@ int main(int argc, char *argv[])
// Filling of faceLabels list // Filling of faceLabels list
label faceI = -1; label faceI = -1;
forAll (polyMeshPatches, patchI) forAll(polyMeshPatches, patchI)
{ {
label start = mesh.boundaryMesh()[patchIDs[patchI]].start(); label start = mesh.boundaryMesh()[patchIDs[patchI]].start();
label size = mesh.boundaryMesh()[patchIDs[patchI]].size(); label size = mesh.boundaryMesh()[patchIDs[patchI]].size();
for(label i = 0; i < size; i++) for (label i = 0; i < size; ++i)
{ {
faceLabels[++faceI] = start + i; faceLabels[++faceI] = start + i;
} }
@ -192,7 +191,7 @@ int main(int argc, char *argv[])
labelList faceCells(faceLabels.size(), -1); labelList faceCells(faceLabels.size(), -1);
forAll (faceCells, faceI) forAll(faceCells, faceI)
{ {
label faceID = faceLabels[faceI]; label faceID = faceLabels[faceI];
@ -214,7 +213,7 @@ int main(int argc, char *argv[])
labelList bndEdgeFaPatchIDs(nTotalEdges - nInternalEdges, -1); labelList bndEdgeFaPatchIDs(nTotalEdges - nInternalEdges, -1);
for (label edgeI = nInternalEdges; edgeI < nTotalEdges; edgeI++) for (label edgeI = nInternalEdges; edgeI < nTotalEdges; ++edgeI)
{ {
label curMeshEdge = meshEdges[edgeI]; label curMeshEdge = meshEdges[edgeI];
@ -222,7 +221,7 @@ int main(int argc, char *argv[])
label patchI = -1; label patchI = -1;
forAll (edgeFaces[curMeshEdge], faceI) forAll(edgeFaces[curMeshEdge], faceI)
{ {
label curFace = edgeFaces[curMeshEdge][faceI]; label curFace = edgeFaces[curMeshEdge][faceI];
@ -234,7 +233,7 @@ int main(int argc, char *argv[])
} }
} }
for(label pI = 0; pI < faPatches.size() - 1; pI++) for (label pI = 0; pI < faPatches.size() - 1; ++pI)
{ {
if if
( (
@ -257,11 +256,11 @@ int main(int argc, char *argv[])
// Set edgeLabels for each faPatch // Set edgeLabels for each faPatch
for(label pI=0; pI<(faPatches.size()-1); pI++) for (label pI=0; pI<(faPatches.size()-1); ++pI)
{ {
SLList<label> tmpList; SLList<label> tmpList;
forAll (bndEdgeFaPatchIDs, eI) forAll(bndEdgeFaPatchIDs, eI)
{ {
if (bndEdgeFaPatchIDs[eI] == pI) if (bndEdgeFaPatchIDs[eI] == pI)
{ {
@ -275,7 +274,7 @@ int main(int argc, char *argv[])
// Check for undefined edges // Check for undefined edges
SLList<label> tmpList; SLList<label> tmpList;
forAll (bndEdgeFaPatchIDs, eI) forAll(bndEdgeFaPatchIDs, eI)
{ {
if (bndEdgeFaPatchIDs[eI] == -1) if (bndEdgeFaPatchIDs[eI] == -1)
{ {
@ -295,7 +294,7 @@ int main(int argc, char *argv[])
// Add good patches to faMesh // Add good patches to faMesh
SLList<faPatch*> faPatchLst; SLList<faPatch*> faPatchLst;
for(label pI = 0; pI < faPatches.size(); pI++) for (label pI = 0; pI < faPatches.size(); ++pI)
{ {
faPatches[pI].dict_.add("type", faPatches[pI].type_); faPatches[pI].dict_.add("type", faPatches[pI].type_);
faPatches[pI].dict_.add("edgeLabels", faPatches[pI].edgeLabels_); faPatches[pI].dict_.add("edgeLabels", faPatches[pI].edgeLabels_);