Updated member type comments

Resolves bug-report http://bugs.openfoam.org/view.php?id=2356
This commit is contained in:
Henry Weller 2016-11-28 21:23:00 +00:00
parent 414b128f7f
commit f281f77e4a
83 changed files with 255 additions and 252 deletions

View File

@ -34,7 +34,7 @@ namespace Foam
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
Foam::scalar Foam::ODESolver::normalizeError
(

View File

@ -25,7 +25,7 @@ License
#include "DictionaryBase.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class IDLListType, class T>
void Foam::DictionaryBase<IDLListType, T>::addEntries()

View File

@ -241,6 +241,7 @@ private:
const label index
);
protected:
// Protected data

View File

@ -78,7 +78,7 @@ const int Foam::Time::maxPrecision_(3 - log10(SMALL));
Foam::word Foam::Time::controlDictName("controlDict");
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::Time::adjustDeltaT()
{

View File

@ -59,6 +59,7 @@ SourceFiles
namespace Foam
{
// Forward declaration of classes
class argList;
@ -86,6 +87,7 @@ class Time
//- The controlDict
IOdictionary controlDict_;
public:
//- Write control options

View File

@ -278,6 +278,8 @@ void Foam::codedBase::createLibrary
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::codedBase::updateLibrary
(
const word& name
@ -350,7 +352,4 @@ Foam::codedBase::~codedBase()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
// ************************************************************************* //

View File

@ -43,7 +43,7 @@ namespace Foam
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::GAMGAgglomeration::compactLevels(const label nCreatedLevels)
{

View File

@ -33,11 +33,11 @@ License
namespace Foam
{
defineTypeNameAndDebug(mapDistributeBase, 0);
defineTypeNameAndDebug(mapDistributeBase, 0);
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
Foam::List<Foam::labelPair> Foam::mapDistributeBase::schedule
(

View File

@ -51,7 +51,7 @@ namespace Foam
}
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::coupledPolyPatch::writeOBJ(Ostream& os, const point& pt)
{

View File

@ -38,7 +38,8 @@ namespace Foam
addToRunTimeSelectionTable(polyPatch, wedgePolyPatch, dictionary);
}
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::wedgePolyPatch::calcGeometry(PstreamBuffers&)
{

View File

@ -43,7 +43,8 @@ namespace Foam
const char* const Foam::faceZone::labelsName = "faceLabels";
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::faceZone::calcFaceZonePatch() const
{

View File

@ -27,7 +27,7 @@ License
#include "Time.H"
#include "interpolationWeights.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class Type>
const Foam::interpolationWeights&

View File

@ -104,6 +104,9 @@ protected:
//- Return (demand driven) interpolator
const interpolationWeights& interpolator() const;
private:
//- Disallow default bitwise assignment
void operator=(const TableBase<Type>&);

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
@ -112,7 +112,7 @@ class kkLOmega
:
public eddyViscosity<incompressible::RASModel>
{
// Private memmber functions
// Private member functions
tmp<volScalarField> fv(const volScalarField& Ret) const;

View File

@ -41,7 +41,7 @@ namespace RASModels
defineTypeNameAndDebug(qZeta, 0);
addToRunTimeSelectionTable(RASModel, qZeta, dictionary);
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
// * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * * //
tmp<volScalarField> qZeta::fMu() const
{

View File

@ -33,7 +33,7 @@ License
namespace Foam
{
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
// * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * * //
template<class TurbulenceModel, class BasicTurbulenceModel>
tmp<volScalarField>

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,8 +87,6 @@ tmp<volScalarField> SpalartAllmarasIDDES<BasicTurbulenceModel>::rd
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class BasicTurbulenceModel>
tmp<volScalarField> SpalartAllmarasIDDES<BasicTurbulenceModel>::fd
(
@ -99,6 +97,8 @@ tmp<volScalarField> SpalartAllmarasIDDES<BasicTurbulenceModel>::fd
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class BasicTurbulenceModel>
tmp<volScalarField> SpalartAllmarasIDDES<BasicTurbulenceModel>::dTilda
(

View File

@ -33,7 +33,7 @@ namespace Foam
namespace LESModels
{
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class BasicTurbulenceModel>
volScalarField dynamicKEqn<BasicTurbulenceModel>::Ck

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
@ -33,7 +33,7 @@ namespace Foam
namespace LESModels
{
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class BasicTurbulenceModel>
void dynamicLagrangian<BasicTurbulenceModel>::correctNut

View File

@ -34,7 +34,7 @@ namespace Foam
namespace RASModels
{
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
// * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * * //
template<class BasicTurbulenceModel>
tmp<volScalarField> realizableKE<BasicTurbulenceModel>::rCmu

View File

@ -34,7 +34,7 @@ namespace Foam
namespace RASModels
{
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class BasicTurbulenceModel>
tmp<volScalarField> v2f<BasicTurbulenceModel>::Ts() const

View File

@ -35,7 +35,7 @@ License
namespace Foam
{
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void kLowReWallFunctionFvPatchScalarField::checkType()
{
@ -51,8 +51,6 @@ void kLowReWallFunctionFvPatchScalarField::checkType()
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
scalar kLowReWallFunctionFvPatchScalarField::yPlusLam
(
const scalar kappa,

View File

@ -238,7 +238,7 @@ private:
protected:
// Protected data
// Protected member data
//- Pointers to cell shape models
static const cellModel* unknownModel;
@ -285,11 +285,12 @@ protected:
cellTable cellTable_;
// Member Functions
// Protected member functions
//- Subclasses are required to supply this information
virtual bool readGeometry(const scalar scaleFactor = 1.0) = 0;
public:
// Static Members

View File

@ -52,7 +52,7 @@ const int Foam::meshReaders::STARCD::starToFoamFaceAddr[4][6] =
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::meshReaders::STARCD::readToNewline(IFstream& is)
{
@ -93,8 +93,6 @@ bool Foam::meshReaders::STARCD::readHeader(IFstream& is, word fileSignature)
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
void Foam::meshReaders::STARCD::readAux(const objectRegistry& registry)
{
boundaryRegion_.readDict(registry);

View File

@ -42,10 +42,8 @@ namespace Foam
addToRunTimeSelectionTable(dynamicFvMesh, dynamicRefineFvMesh, IOobject);
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
// the PackedBoolList::count method would probably be faster
// since we are only checking for 'true' anyhow
Foam::label Foam::dynamicRefineFvMesh::count
(
const PackedBoolList& l,
@ -250,10 +248,10 @@ Foam::dynamicRefineFvMesh::refine
}
}
// // Remove the stored tet base points
// tetBasePtIsPtr_.clear();
// // Remove the cell tree
// cellTreePtr_.clear();
// // Remove the stored tet base points
// tetBasePtIsPtr_.clear();
// // Remove the cell tree
// cellTreePtr_.clear();
// Update fields
updateMesh(map);
@ -463,8 +461,6 @@ Foam::dynamicRefineFvMesh::refine
}
// Combines previously split cells, maps fields and recalculates
// (an approximate) flux
Foam::autoPtr<Foam::mapPolyMesh>
Foam::dynamicRefineFvMesh::unrefine
(
@ -646,7 +642,6 @@ Foam::dynamicRefineFvMesh::unrefine
}
// Get max of connected point
Foam::scalarField
Foam::dynamicRefineFvMesh::maxPointField(const scalarField& pFld) const
{
@ -665,7 +660,6 @@ Foam::dynamicRefineFvMesh::maxPointField(const scalarField& pFld) const
}
// Get max of connected cell
Foam::scalarField
Foam::dynamicRefineFvMesh::maxCellField(const volScalarField& vFld) const
{
@ -684,7 +678,6 @@ Foam::dynamicRefineFvMesh::maxCellField(const volScalarField& vFld) const
}
// Simple (non-parallel) interpolation by averaging.
Foam::scalarField
Foam::dynamicRefineFvMesh::cellToPoint(const scalarField& vFld) const
{
@ -705,7 +698,6 @@ Foam::dynamicRefineFvMesh::cellToPoint(const scalarField& vFld) const
}
// Calculate error. Is < 0 or distance to minLevel, maxLevel
Foam::scalarField Foam::dynamicRefineFvMesh::error
(
const scalarField& fld,

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -104,7 +104,7 @@ protected:
PackedBoolList protectedCell_;
// Private Member Functions
// Protected Member Functions
//- Count set/unset elements in packedlist.
static label count(const PackedBoolList&, const unsigned int);

View File

@ -70,6 +70,7 @@ class boundaryMesh
// the largest distance from face centre to one of its vertices.
static const scalar distanceTol_;
// Private data
//- All boundary mesh data. Reconstructed every time faces are repatched

View File

@ -62,9 +62,8 @@ Foam::autoPtr<Foam::cellLooper> Foam::cellLooper::New
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
// Get faces (on cell) connected to vertI which are not using edgeI
Foam::labelList Foam::cellLooper::getVertFacesNonEdge
(
const label celli,
@ -101,7 +100,6 @@ Foam::labelList Foam::cellLooper::getVertFacesNonEdge
}
// Get first edge connected to vertI and on facei
Foam::label Foam::cellLooper::getFirstVertEdge
(
const label facei,
@ -131,7 +129,6 @@ Foam::label Foam::cellLooper::getFirstVertEdge
}
// Get edges (on cell) connected to vertI which are not on facei
Foam::labelList Foam::cellLooper::getVertEdgesNonFace
(
const label celli,
@ -166,8 +163,6 @@ Foam::labelList Foam::cellLooper::getVertEdgesNonFace
}
// Return edge from cellEdges that is most perpendicular
// to refinement direction.
Foam::label Foam::cellLooper::getMisAlignedEdge
(
const vector& refDir,

View File

@ -71,8 +71,6 @@ class cellLooper
:
public edgeVertex
{
// Private data
protected:
@ -105,6 +103,7 @@ protected:
// to refinement direction.
label getMisAlignedEdge(const vector& refDir, const label celli) const;
private:
// Private Member Functions

View File

@ -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
@ -72,6 +72,7 @@ protected:
//- Point motion field
mutable pointScalarField pointDisplacement_;
private:
// Private Member Functions
@ -88,6 +89,7 @@ private:
//- Disallow default bitwise assignment
void operator=(const componentDisplacementMotionSolver&);
public:
//- Runtime type information

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -69,6 +69,7 @@ protected:
//- Point motion field
mutable pointScalarField pointMotionU_;
private:
// Private Member Functions
@ -85,6 +86,7 @@ private:
//- Disallow default bitwise assignment
void operator=(const componentVelocityMotionSolver&);
public:
//- Runtime type information

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
@ -82,6 +82,7 @@ class edgeMesh
//- From point to edges
mutable autoPtr<labelListList> pointEdgesPtr_;
// Private Member Functions
//- Calculate point-edge addressing (inverse of edges)

View File

@ -56,7 +56,7 @@ inline void Foam::fileFormats::STARCDedgeFormat::writeLines
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::fileFormats::STARCDedgeFormat::writeCase
(

View File

@ -99,6 +99,7 @@ protected:
const label nEdges
);
public:
// Constructors

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,7 @@ License
#include "vtkUnstructuredReader.H"
#include "Time.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::fileFormats::VTKedgeFormat::writeHeader
(

View File

@ -23,6 +23,20 @@ License
\*---------------------------------------------------------------------------*/
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
inline Foam::pointField& Foam::edgeMesh::storedPoints()
{
return points_;
}
inline Foam::edgeList& Foam::edgeMesh::storedEdges()
{
return edges_;
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
inline Foam::edgeMesh::edgeMesh(const edgeMesh& em)
@ -58,18 +72,6 @@ inline const Foam::labelListList& Foam::edgeMesh::pointEdges() const
}
inline Foam::pointField& Foam::edgeMesh::storedPoints()
{
return points_;
}
inline Foam::edgeList& Foam::edgeMesh::storedEdges()
{
return edges_;
}
// * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
void Foam::edgeMesh::operator=(const edgeMesh& rhs)

View File

@ -168,7 +168,7 @@ bool Foam::extendedEdgeMesh::canRead
}
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
Foam::extendedEdgeMesh::pointStatus
Foam::extendedEdgeMesh::classifyFeaturePoint

View File

@ -141,7 +141,7 @@ protected:
static label externalStart_;
// Private data
// Protected data
//- Index of the start of the concave feature points
label concaveStart_;
@ -203,7 +203,7 @@ protected:
mutable PtrList<indexedOctree<treeDataEdge>> edgeTreesByType_;
// Private Member Functions
// Protected Member Functions
//- Classify the type of feature point. Requires valid stored member
// data for edges and normals.

View File

@ -53,7 +53,7 @@ Foam::autoPtr<Foam::writer<Type>> Foam::writer<Type>::New
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class Type>
Foam::fileName Foam::writer<Type>::getBaseName

View File

@ -30,7 +30,7 @@ License
#include "coupledFvPatchFields.H"
#include "UIndirectList.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class Type>
template<class Type2>

View File

@ -28,7 +28,7 @@ License
#include "SortableList.H"
#include "emptyPolyPatch.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::cellToCellStencil::merge
(

View File

@ -32,11 +32,11 @@ License
namespace Foam
{
defineTypeNameAndDebug(extendedCellToFaceStencil, 0);
defineTypeNameAndDebug(extendedCellToFaceStencil, 0);
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::extendedCellToFaceStencil::writeStencilStats
(

View File

@ -72,7 +72,7 @@ protected:
const polyMesh& mesh_;
protected:
// Protected member functions
//- Write some statistics about stencil
static void writeStencilStats
@ -82,6 +82,7 @@ protected:
const mapDistribute& map
);
public:
// Declare name of the class and its debug switch

View File

@ -29,7 +29,7 @@ License
#include "syncTools.H"
#include "dummyTransform.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::cellToFaceStencil::merge
(

View File

@ -131,6 +131,8 @@ Foam::lduInterfacePtrsList Foam::fvBoundaryMesh::interfaces() const
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::fvBoundaryMesh::readUpdate(const polyBoundaryMesh& basicBdry)
{
clear();

View File

@ -33,7 +33,7 @@ int Foam::cellPointWeight::debug(debug::debugSwitch("cellPointWeight", 0));
Foam::scalar Foam::cellPointWeight::tol(SMALL);
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::cellPointWeight::findTetrahedron
(

View File

@ -36,7 +36,7 @@ namespace Foam
Foam::scalar Foam::pointMVCWeight::tol(SMALL);
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::pointMVCWeight::calcWeights
(

View File

@ -202,7 +202,6 @@ private:
// Private Member Functions
//- Disallow default bitwise copy construct
effectivenessHeatExchangerSource
(

View File

@ -47,7 +47,7 @@ namespace fv
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::fv::meanVelocityForce::writeProps
(

View File

@ -29,7 +29,7 @@ License
#include "dynamicCode.H"
#include "dynamicCodeContext.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class Type>
void Foam::fv::CodedSource<Type>::prepare

View File

@ -487,6 +487,8 @@ void Foam::ReactingMultiphaseParcel<ParcelType>::calc
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class ParcelType>
template<class TrackData>
void Foam::ReactingMultiphaseParcel<ParcelType>::calcDevolatilisation

View File

@ -74,6 +74,8 @@ void Foam::FacePostProcessing<CloudType>::makeLogFile
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class CloudType>
void Foam::FacePostProcessing<CloudType>::write()
{

View File

@ -385,6 +385,8 @@ void Foam::ParticleCollector<CloudType>::collectParcelConcentricCircles
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class CloudType>
void Foam::ParticleCollector<CloudType>::write()
{

View File

@ -25,7 +25,7 @@ License
#include "NonSphereDragForce.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class CloudType>
Foam::scalar Foam::NonSphereDragForce<CloudType>::CdRe(const scalar Re) const

View File

@ -27,6 +27,13 @@ License
#include "runTimeSelectionTables.H"
#include "pointMesh.H"
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class Type>
void Foam::AveragingMethod<Type>::updateGrad()
{}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
template<class Type>
@ -106,15 +113,6 @@ Foam::AveragingMethod<Type>::~AveragingMethod()
{}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
template<class Type>
void Foam::AveragingMethod<Type>::updateGrad()
{
// do nothing
}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
template<class Type>

View File

@ -29,7 +29,7 @@ License
using namespace Foam::constant::mathematical;
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class CloudType>
Foam::tmp<Foam::scalarField> Foam::LiquidEvaporation<CloudType>::calcXc

View File

@ -29,7 +29,7 @@ License
using namespace Foam::constant::mathematical;
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class CloudType>
Foam::tmp<Foam::scalarField> Foam::LiquidEvaporationBoil<CloudType>::calcXc

View File

@ -81,6 +81,8 @@ Foam::word Foam::ThermoSurfaceFilm<CloudType>::interactionTypeStr
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class CloudType>
Foam::vector Foam::ThermoSurfaceFilm<CloudType>::tangentVector
(

View File

@ -35,8 +35,7 @@ namespace Foam
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::pairPotential::scaleEnergy(scalar& e, const scalar r) const
{

View File

@ -60,7 +60,7 @@ class pairPotential
protected:
// Protected data
// Protected member data
word name_;
dictionary pairPotentialProperties_;
@ -79,7 +79,7 @@ protected:
bool writeTables_;
// Private Member Functions
// Protected member functions
void scaleEnergy(scalar& e, const scalar r) const;
@ -93,7 +93,7 @@ protected:
public:
//- Runtime type information
TypeName("pairPotential");
TypeName("pairPotential");
// Declare run-time constructor selection table

View File

@ -25,7 +25,7 @@ License
#include "polyLine.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::polyLine::calcParam()
{

View File

@ -298,59 +298,6 @@ void Foam::refinementFeatures::buildTrees(const label featI)
}
const Foam::PtrList<Foam::indexedOctree<Foam::treeDataEdge>>&
Foam::refinementFeatures::regionEdgeTrees() const
{
if (!regionEdgeTreesPtr_.valid())
{
regionEdgeTreesPtr_.reset
(
new PtrList<indexedOctree<treeDataEdge>>(size())
);
PtrList<indexedOctree<treeDataEdge>>& trees = regionEdgeTreesPtr_();
forAll(*this, featI)
{
const extendedEdgeMesh& eMesh = operator[](featI);
const pointField& points = eMesh.points();
const edgeList& edges = eMesh.edges();
// Calculate bb of all points
treeBoundBox bb(points);
// Random number generator. Bit dodgy since not exactly random ;-)
Random rndGen(65431);
// Slightly extended bb. Slightly off-centred just so on symmetric
// geometry there are less face/edge aligned items.
bb = bb.extend(rndGen, 1e-4);
bb.min() -= point(ROOTVSMALL, ROOTVSMALL, ROOTVSMALL);
bb.max() += point(ROOTVSMALL, ROOTVSMALL, ROOTVSMALL);
trees.set
(
featI,
new indexedOctree<treeDataEdge>
(
treeDataEdge
(
false, // do not cache bb
edges,
points,
eMesh.regionEdges()
),
bb, // overall search domain
8, // maxLevel
10, // leafsize
3.0 // duplicity
)
);
}
}
return regionEdgeTreesPtr_();
}
// Find maximum level of a shell.
void Foam::refinementFeatures::findHigherLevel
(
@ -424,6 +371,61 @@ void Foam::refinementFeatures::findHigherLevel
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
const Foam::PtrList<Foam::indexedOctree<Foam::treeDataEdge>>&
Foam::refinementFeatures::regionEdgeTrees() const
{
if (!regionEdgeTreesPtr_.valid())
{
regionEdgeTreesPtr_.reset
(
new PtrList<indexedOctree<treeDataEdge>>(size())
);
PtrList<indexedOctree<treeDataEdge>>& trees = regionEdgeTreesPtr_();
forAll(*this, featI)
{
const extendedEdgeMesh& eMesh = operator[](featI);
const pointField& points = eMesh.points();
const edgeList& edges = eMesh.edges();
// Calculate bb of all points
treeBoundBox bb(points);
// Random number generator. Bit dodgy since not exactly random ;-)
Random rndGen(65431);
// Slightly extended bb. Slightly off-centred just so on symmetric
// geometry there are less face/edge aligned items.
bb = bb.extend(rndGen, 1e-4);
bb.min() -= point(ROOTVSMALL, ROOTVSMALL, ROOTVSMALL);
bb.max() += point(ROOTVSMALL, ROOTVSMALL, ROOTVSMALL);
trees.set
(
featI,
new indexedOctree<treeDataEdge>
(
treeDataEdge
(
false, // do not cache bb
edges,
points,
eMesh.regionEdges()
),
bb, // overall search domain
8, // maxLevel
10, // leafsize
3.0 // duplicity
)
);
}
}
return regionEdgeTreesPtr_();
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::refinementFeatures::refinementFeatures

View File

@ -53,8 +53,6 @@ class refinementFeatures
:
public PtrList<extendedFeatureEdgeMesh>
{
private:
// Private data
//- Per shell the list of ranges

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
@ -54,9 +54,6 @@ class regionModel1D
:
public regionModel
{
private:
// Private Member Functions
//- Disallow default bitwise copy construct

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
@ -52,9 +52,6 @@ class singleLayerRegion
:
public regionModel
{
private:
// Private Member Functions
//- Disallow default bitwise copy construct

View File

@ -65,8 +65,6 @@ class thermoSingleLayer
:
public kinematicSingleLayer
{
private:
// Private member functions
//- Disallow default bitwise copy construct

View File

@ -26,7 +26,7 @@ License
#include "OppositeFaceCellWave.H"
#include "polyMesh.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class Type, class TrackingData>
void Foam::OppositeFaceCellWave<Type, TrackingData>::opposingFaceLabels

View File

@ -52,14 +52,14 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class OppositeFaceCellWaveName Declaration
Class OppositeFaceCellWaveName Declaration
\*---------------------------------------------------------------------------*/
TemplateName(OppositeFaceCellWave);
/*---------------------------------------------------------------------------*\
Class OppositeFaceCellWave Declaration
Class OppositeFaceCellWave Declaration
\*---------------------------------------------------------------------------*/
template<class Type, class TrackingData = int>

View File

@ -334,32 +334,7 @@ void Foam::cuttingPlane::walkCellCuts
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
// Construct without cutting
Foam::cuttingPlane::cuttingPlane(const plane& pln)
:
plane(pln)
{}
// Construct from plane and mesh reference, restricted to a list of cells
Foam::cuttingPlane::cuttingPlane
(
const plane& pln,
const primitiveMesh& mesh,
const bool triangulate,
const labelUList& cellIdLabels
)
:
plane(pln)
{
reCut(mesh, triangulate, cellIdLabels);
}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::cuttingPlane::reCut
(
@ -406,6 +381,30 @@ void Foam::cuttingPlane::remapFaces
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
// Construct without cutting
Foam::cuttingPlane::cuttingPlane(const plane& pln)
:
plane(pln)
{}
// Construct from plane and mesh reference, restricted to a list of cells
Foam::cuttingPlane::cuttingPlane
(
const plane& pln,
const primitiveMesh& mesh,
const bool triangulate,
const labelUList& cellIdLabels
)
:
plane(pln)
{
reCut(mesh, triangulate, cellIdLabels);
}
// * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
void Foam::cuttingPlane::operator=(const cuttingPlane& rhs)

View File

@ -39,7 +39,7 @@ namespace Foam
Foam::scalar Foam::meshToMeshMethod::tolerance_ = 1e-6;
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
Foam::labelList Foam::meshToMeshMethod::maskCells() const
{

View File

@ -46,7 +46,7 @@ namespace Foam
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::probes::findElements(const fvMesh& mesh)
{

View File

@ -90,7 +90,7 @@ protected:
};
// Private data
// Protected member data
//- Const reference to fvMesh
const fvMesh& mesh_;
@ -140,7 +140,7 @@ protected:
HashPtrTable<OFstream> probeFilePtrs_;
// Private Member Functions
// Protected Member Functions
//- Clear old field groups
void clearFieldGroups();

View File

@ -39,7 +39,7 @@ namespace Foam
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
Foam::label Foam::sampledSet::getBoundaryCell(const label facei) const
{

View File

@ -39,15 +39,6 @@ namespace Foam
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
void Foam::sampledSurface::clearGeom() const
{
deleteDemandDrivenData(SfPtr_);
deleteDemandDrivenData(magSfPtr_);
deleteDemandDrivenData(CfPtr_);
area_ = -1;
}
void Foam::sampledSurface::makeSf() const
{
// It is an error to recalculate if the pointer is already set
@ -111,6 +102,17 @@ void Foam::sampledSurface::makeCf() const
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::sampledSurface::clearGeom() const
{
deleteDemandDrivenData(SfPtr_);
deleteDemandDrivenData(magSfPtr_);
deleteDemandDrivenData(CfPtr_);
area_ = -1;
}
// * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * //
Foam::autoPtr<Foam::sampledSurface> Foam::sampledSurface::New

View File

@ -69,6 +69,32 @@ Foam::word Foam::surfMesh::meshSubDir = "surfMesh";
// }
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::surfMesh::updatePointsRef()
{
// Assign the reference to the points (this is truly ugly)
reinterpret_cast<SubField<point>&>
(
const_cast<Field<point>&>(MeshReference::points())
) = reinterpret_cast<SubField<point>&>(this->storedPoints());
}
void Foam::surfMesh::updateFacesRef()
{
// Assign the reference to the faces
shallowCopy(this->storedFaces());
}
void Foam::surfMesh::updateRefs()
{
this->updatePointsRef();
this->updateFacesRef();
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::surfMesh::surfMesh(const IOobject& io, const word& surfName)
@ -227,30 +253,6 @@ Foam::surfMesh::~surfMesh()
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
void Foam::surfMesh::updatePointsRef()
{
// Assign the reference to the points (this is truly ugly)
reinterpret_cast<SubField<point>&>
(
const_cast<Field<point>&>(MeshReference::points())
) = reinterpret_cast<SubField<point>&>(this->storedPoints());
}
void Foam::surfMesh::updateFacesRef()
{
// Assign the reference to the faces
shallowCopy(this->storedFaces());
}
void Foam::surfMesh::updateRefs()
{
this->updatePointsRef();
this->updateFacesRef();
}
void Foam::surfMesh::resetPrimitives
(
const Xfer<pointField>& points,

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
@ -28,7 +28,7 @@ License
#include "IFstream.H"
#include "IStringStream.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
bool Foam::fileFormats::AC3DsurfaceFormatCore::readCmd
(

View File

@ -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
@ -26,7 +26,7 @@ License
#include "OFSsurfaceFormatCore.H"
#include "clock.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::fileFormats::OFSsurfaceFormatCore::writeHeader
(

View File

@ -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
@ -28,7 +28,7 @@ License
#include "regExp.H"
#include "IStringStream.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
// parse things like this:
// CTNAME 1 someName

View File

@ -26,7 +26,7 @@ License
#include "VTKsurfaceFormatCore.H"
#include "clock.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::fileFormats::VTKsurfaceFormatCore::writeHeader
(

View File

@ -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
@ -26,7 +26,7 @@ License
#include "WRLsurfaceFormatCore.H"
#include "clock.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::fileFormats::WRLsurfaceFormatCore::writeHeader
(

View File

@ -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
@ -26,7 +26,7 @@ License
#include "X3DsurfaceFormatCore.H"
#include "clock.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::fileFormats::X3DsurfaceFormatCore::writeHeader
(

View File

@ -40,7 +40,7 @@ namespace Foam
defineTypeNameAndDebug(psiuReactionThermo, 0);
defineRunTimeSelectionTable(psiuReactionThermo, fvMesh);
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
wordList psiuReactionThermo::heuBoundaryTypes()
{

View File

@ -36,10 +36,12 @@ License
namespace Foam
{
defineTypeNameAndDebug(triSurface, 0);
defineTypeNameAndDebug(triSurface, 0);
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
Foam::fileName Foam::triSurface::triSurfInstance(const Time& d)
{
fileName foamName(d.caseName() + ".ftr");