Commit 8b219fed authored by Henry Weller's avatar Henry Weller
Browse files

Updated member type comments

See http://bugs.openfoam.org/view.php?id=2356
parent 0013284e
......@@ -40,7 +40,7 @@ namespace functionObjects
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::functionObjects::fieldAverage::resetFields()
{
......
......@@ -185,7 +185,7 @@ protected:
label periodIndex_;
// Private Member Functions
// Protected Member Functions
// Initialisation routines
......
......@@ -52,7 +52,7 @@ const Foam::NamedEnum
> Foam::functionObjects::fieldMinMax::modeTypeNames_;
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::functionObjects::fieldMinMax::writeFileHeader(const label i)
{
......
......@@ -123,7 +123,7 @@ protected:
wordList fieldSet_;
// Private Member Functions
// Protected Member Functions
//- Helper function to write the output
template<class Type>
......
......@@ -98,7 +98,7 @@ const Foam::NamedEnum
> Foam::functionObjects::fieldValues::surfaceFieldValue::operationTypeNames_;
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::functionObjects::fieldValues::surfaceFieldValue::setFaceZoneFaces()
{
......
......@@ -42,7 +42,7 @@ namespace functionObjects
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::functionObjects::nearWallFields::calcAddressing()
{
......
......@@ -33,7 +33,7 @@ const std::size_t Foam::wallBoundedParticle::sizeofFields_
);
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
Foam::edge Foam::wallBoundedParticle::currentEdge() const
{
......
......@@ -47,7 +47,7 @@ namespace Foam
);
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::codedFunctionObject::prepare
(
......
......@@ -37,9 +37,6 @@ SourceFiles
#include "treeBoundBox.H"
#include "searchableSurface.H"
//#include "edgeMesh.H"
//#include "indexedOctree.H"
//#include "treeDataEdge.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
......@@ -59,8 +56,6 @@ class searchableCurve
:
public searchableSurface
{
private:
// Private Member Data
//- Feature
......@@ -222,15 +217,11 @@ public:
NotImplemented;
}
// regIOobject implementation
bool writeData(Ostream&) const
{
NotImplemented;
return false;
}
};
......
......@@ -28,7 +28,7 @@ License
#include "mapDistribute.H"
#include "unitConversion.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class SourcePatch, class TargetPatch>
void Foam::AMIMethod<SourcePatch, TargetPatch>::checkPatches() const
......
......@@ -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
(
const primitivePatch& half0,
......@@ -319,7 +281,7 @@ void Foam::cyclicAMIPolyPatch::calcTransforms
}
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * * //
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)
{
// Clear the invalid AMI
......
......@@ -53,9 +53,6 @@ class cyclicAMIPolyPatch
:
public coupledPolyPatch
{
private:
// Private Member Functions
//- Return normal of face at max distance from rotation axis
......
......@@ -104,7 +104,7 @@ namespace Foam
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class Type, class TrackingData>
bool Foam::FaceCellWave<Type, TrackingData>::updateCell
......
......@@ -77,8 +77,6 @@ class FaceCellWave
:
public FaceCellWaveName
{
private:
// Private Member Functions
//- Disallow default bitwise copy construct
......@@ -90,7 +88,7 @@ private:
protected:
// Private data
// Protected data
//- Reference to mesh
const polyMesh& mesh_;
......@@ -244,7 +242,7 @@ protected:
void handleExplicitConnections();
// Private static data
// Protected static data
static const scalar geomTol_;
static scalar propagationTol_;
......
......@@ -133,7 +133,7 @@ public:
//- Helper class for finding nearest
// Nearest:
// Nearest:
// - point+local index
// - sqr(distance)
// - processor
......
......@@ -134,7 +134,7 @@ Foam::Istream& Foam::topoSetSource::checkIs(Istream& is)
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
void Foam::topoSetSource::addOrDelete
(
......
......@@ -130,7 +130,7 @@ Foam::fileName Foam::topoSet::localPath
}
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
// Update stored cell numbers using map.
// Do in two passes to prevent allocation if nothing changed.
......
......@@ -159,7 +159,7 @@ class triSurfaceTools
);
//- 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
// (and hence no edge angle can be defined)
static scalar collapseMinCosAngle
......
......@@ -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 * * * * * * * * * * * * * * * //
Foam::RBD::rigidBodyModel::rigidBodyModel()
......@@ -168,52 +215,7 @@ Foam::RBD::rigidBodyModel::~rigidBodyModel()
{}
// * * * * * * * * * * * * * * 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;
}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
Foam::label Foam::RBD::rigidBodyModel::join
(
......
......@@ -36,7 +36,7 @@ namespace Foam
}
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
// * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * * //
void Foam::incompressibleTwoPhaseMixture::calcNu()
{
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment