Updated member type comments

See http://bugs.openfoam.org/view.php?id=2356
This commit is contained in:
Henry Weller
2016-11-28 09:22:56 +00:00
parent 4eaa06a60f
commit 8bfff27468
21 changed files with 104 additions and 118 deletions

View File

@ -40,7 +40,7 @@ namespace functionObjects
} }
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::functionObjects::fieldAverage::resetFields() void Foam::functionObjects::fieldAverage::resetFields()
{ {

View File

@ -185,7 +185,7 @@ protected:
label periodIndex_; label periodIndex_;
// Private Member Functions // Protected Member Functions
// Initialisation routines // Initialisation routines

View File

@ -52,7 +52,7 @@ const Foam::NamedEnum
> Foam::functionObjects::fieldMinMax::modeTypeNames_; > Foam::functionObjects::fieldMinMax::modeTypeNames_;
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::functionObjects::fieldMinMax::writeFileHeader(const label i) void Foam::functionObjects::fieldMinMax::writeFileHeader(const label i)
{ {

View File

@ -123,7 +123,7 @@ protected:
wordList fieldSet_; wordList fieldSet_;
// Private Member Functions // Protected Member Functions
//- Helper function to write the output //- Helper function to write the output
template<class Type> template<class Type>

View File

@ -98,7 +98,7 @@ const Foam::NamedEnum
> Foam::functionObjects::fieldValues::surfaceFieldValue::operationTypeNames_; > Foam::functionObjects::fieldValues::surfaceFieldValue::operationTypeNames_;
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::functionObjects::fieldValues::surfaceFieldValue::setFaceZoneFaces() void Foam::functionObjects::fieldValues::surfaceFieldValue::setFaceZoneFaces()
{ {

View File

@ -42,7 +42,7 @@ namespace functionObjects
} }
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::functionObjects::nearWallFields::calcAddressing() void Foam::functionObjects::nearWallFields::calcAddressing()
{ {

View File

@ -33,7 +33,7 @@ const std::size_t Foam::wallBoundedParticle::sizeofFields_
); );
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
Foam::edge Foam::wallBoundedParticle::currentEdge() const Foam::edge Foam::wallBoundedParticle::currentEdge() const
{ {

View File

@ -47,7 +47,7 @@ namespace Foam
); );
} }
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::codedFunctionObject::prepare void Foam::codedFunctionObject::prepare
( (

View File

@ -37,9 +37,6 @@ SourceFiles
#include "treeBoundBox.H" #include "treeBoundBox.H"
#include "searchableSurface.H" #include "searchableSurface.H"
//#include "edgeMesh.H"
//#include "indexedOctree.H"
//#include "treeDataEdge.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
@ -59,8 +56,6 @@ class searchableCurve
: :
public searchableSurface public searchableSurface
{ {
private:
// Private Member Data // Private Member Data
//- Feature //- Feature
@ -222,15 +217,11 @@ public:
NotImplemented; NotImplemented;
} }
// regIOobject implementation
bool writeData(Ostream&) const bool writeData(Ostream&) const
{ {
NotImplemented; NotImplemented;
return false; return false;
} }
}; };

View File

@ -28,7 +28,7 @@ License
#include "mapDistribute.H" #include "mapDistribute.H"
#include "unitConversion.H" #include "unitConversion.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class SourcePatch, class TargetPatch> template<class SourcePatch, class TargetPatch>
void Foam::AMIMethod<SourcePatch, TargetPatch>::checkPatches() const void Foam::AMIMethod<SourcePatch, TargetPatch>::checkPatches() const

View File

@ -67,44 +67,6 @@ Foam::vector Foam::cyclicAMIPolyPatch::findFaceNormalMaxRadius
} }
// * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * * //
void Foam::cyclicAMIPolyPatch::calcTransforms()
{
const cyclicAMIPolyPatch& half0 = *this;
vectorField half0Areas(half0.size());
forAll(half0, facei)
{
half0Areas[facei] = half0[facei].normal(half0.points());
}
const cyclicAMIPolyPatch& half1 = neighbPatch();
vectorField half1Areas(half1.size());
forAll(half1, facei)
{
half1Areas[facei] = half1[facei].normal(half1.points());
}
calcTransforms
(
half0,
half0.faceCentres(),
half0Areas,
half1.faceCentres(),
half1Areas
);
if (debug)
{
Pout<< "calcTransforms() : patch: " << name() << nl
<< " forwardT = " << forwardT() << nl
<< " reverseT = " << reverseT() << nl
<< " separation = " << separation() << nl
<< " collocated = " << collocated() << nl << endl;
}
}
void Foam::cyclicAMIPolyPatch::calcTransforms void Foam::cyclicAMIPolyPatch::calcTransforms
( (
const primitivePatch& half0, const primitivePatch& half0,
@ -319,7 +281,7 @@ void Foam::cyclicAMIPolyPatch::calcTransforms
} }
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * // // * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * * //
void Foam::cyclicAMIPolyPatch::resetAMI void Foam::cyclicAMIPolyPatch::resetAMI
( (
@ -395,6 +357,42 @@ void Foam::cyclicAMIPolyPatch::resetAMI
} }
void Foam::cyclicAMIPolyPatch::calcTransforms()
{
const cyclicAMIPolyPatch& half0 = *this;
vectorField half0Areas(half0.size());
forAll(half0, facei)
{
half0Areas[facei] = half0[facei].normal(half0.points());
}
const cyclicAMIPolyPatch& half1 = neighbPatch();
vectorField half1Areas(half1.size());
forAll(half1, facei)
{
half1Areas[facei] = half1[facei].normal(half1.points());
}
calcTransforms
(
half0,
half0.faceCentres(),
half0Areas,
half1.faceCentres(),
half1Areas
);
if (debug)
{
Pout<< "calcTransforms() : patch: " << name() << nl
<< " forwardT = " << forwardT() << nl
<< " reverseT = " << reverseT() << nl
<< " separation = " << separation() << nl
<< " collocated = " << collocated() << nl << endl;
}
}
void Foam::cyclicAMIPolyPatch::initGeometry(PstreamBuffers& pBufs) void Foam::cyclicAMIPolyPatch::initGeometry(PstreamBuffers& pBufs)
{ {
// Clear the invalid AMI // Clear the invalid AMI

View File

@ -53,9 +53,6 @@ class cyclicAMIPolyPatch
: :
public coupledPolyPatch public coupledPolyPatch
{ {
private:
// Private Member Functions // Private Member Functions
//- Return normal of face at max distance from rotation axis //- Return normal of face at max distance from rotation axis

View File

@ -104,7 +104,7 @@ namespace Foam
} }
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class Type, class TrackingData> template<class Type, class TrackingData>
bool Foam::FaceCellWave<Type, TrackingData>::updateCell bool Foam::FaceCellWave<Type, TrackingData>::updateCell

View File

@ -77,8 +77,6 @@ class FaceCellWave
: :
public FaceCellWaveName public FaceCellWaveName
{ {
private:
// Private Member Functions // Private Member Functions
//- Disallow default bitwise copy construct //- Disallow default bitwise copy construct
@ -90,7 +88,7 @@ private:
protected: protected:
// Private data // Protected data
//- Reference to mesh //- Reference to mesh
const polyMesh& mesh_; const polyMesh& mesh_;
@ -244,7 +242,7 @@ protected:
void handleExplicitConnections(); void handleExplicitConnections();
// Private static data // Protected static data
static const scalar geomTol_; static const scalar geomTol_;
static scalar propagationTol_; static scalar propagationTol_;

View File

@ -134,7 +134,7 @@ Foam::Istream& Foam::topoSetSource::checkIs(Istream& is)
} }
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::topoSetSource::addOrDelete void Foam::topoSetSource::addOrDelete
( (

View File

@ -130,7 +130,7 @@ Foam::fileName Foam::topoSet::localPath
} }
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
// Update stored cell numbers using map. // Update stored cell numbers using map.
// Do in two passes to prevent allocation if nothing changed. // Do in two passes to prevent allocation if nothing changed.

View File

@ -159,7 +159,7 @@ class triSurfaceTools
); );
//- Calculate minimum (cos of) edge angle using addressing from //- Calculate minimum (cos of) edge angle using addressing from
/// collapsing // collapsing
// edge to v1 at pt. Returns 1 if v1 is on edge without neighbours // edge to v1 at pt. Returns 1 if v1 is on edge without neighbours
// (and hence no edge angle can be defined) // (and hence no edge angle can be defined)
static scalar collapseMinCosAngle static scalar collapseMinCosAngle

View File

@ -114,6 +114,53 @@ void Foam::RBD::rigidBodyModel::addRestraints
} }
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
Foam::label Foam::RBD::rigidBodyModel::join_
(
const label parentID,
const spatialTransform& XT,
autoPtr<joint> jointPtr,
autoPtr<rigidBody> bodyPtr
)
{
// Append the body
const rigidBody& body = bodyPtr();
bodies_.append(bodyPtr);
const label bodyID = nBodies()-1;
bodyIDs_.insert(body.name(), bodyID);
// If the parentID refers to a merged body find the parent into which it has
// been merged and set lambda and XT accordingly
if (merged(parentID))
{
const subBody& sBody = mergedBody(parentID);
lambda_.append(sBody.masterID());
XT_.append(XT & sBody.masterXT());
}
else
{
lambda_.append(parentID);
XT_.append(XT);
}
// Append the joint
const joint& prevJoint = joints_[joints_.size() - 1];
joints_.append(jointPtr);
joint& curJoint = joints_[joints_.size() - 1];
curJoint.index() = joints_.size() - 1;
curJoint.qIndex() = prevJoint.qIndex() + prevJoint.nDoF();
// Increment the degrees of freedom
nDoF_ += curJoint.nDoF();
unitQuaternions_ = unitQuaternions_ || curJoint.unitQuaternion();
resizeState();
return bodyID;
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * * //
Foam::RBD::rigidBodyModel::rigidBodyModel() Foam::RBD::rigidBodyModel::rigidBodyModel()
@ -168,52 +215,7 @@ Foam::RBD::rigidBodyModel::~rigidBodyModel()
{} {}
// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
Foam::label Foam::RBD::rigidBodyModel::join_
(
const label parentID,
const spatialTransform& XT,
autoPtr<joint> jointPtr,
autoPtr<rigidBody> bodyPtr
)
{
// Append the body
const rigidBody& body = bodyPtr();
bodies_.append(bodyPtr);
const label bodyID = nBodies()-1;
bodyIDs_.insert(body.name(), bodyID);
// If the parentID refers to a merged body find the parent into which it has
// been merged and set lambda and XT accordingly
if (merged(parentID))
{
const subBody& sBody = mergedBody(parentID);
lambda_.append(sBody.masterID());
XT_.append(XT & sBody.masterXT());
}
else
{
lambda_.append(parentID);
XT_.append(XT);
}
// Append the joint
const joint& prevJoint = joints_[joints_.size() - 1];
joints_.append(jointPtr);
joint& curJoint = joints_[joints_.size() - 1];
curJoint.index() = joints_.size() - 1;
curJoint.qIndex() = prevJoint.qIndex() + prevJoint.nDoF();
// Increment the degrees of freedom
nDoF_ += curJoint.nDoF();
unitQuaternions_ = unitQuaternions_ || curJoint.unitQuaternion();
resizeState();
return bodyID;
}
Foam::label Foam::RBD::rigidBodyModel::join Foam::label Foam::RBD::rigidBodyModel::join
( (

View File

@ -36,7 +36,7 @@ namespace Foam
} }
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * // // * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * * //
void Foam::incompressibleTwoPhaseMixture::calcNu() void Foam::incompressibleTwoPhaseMixture::calcNu()
{ {

View File

@ -2,7 +2,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) 2011-2014 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -72,7 +72,7 @@ protected:
volScalarField nu_; volScalarField nu_;
// Private Member Functions // Protected Member Functions
//- Calculate and return the laminar viscosity //- Calculate and return the laminar viscosity
void calcNu(); void calcNu();