STYLE: finiteArea: add/fix comments

STYLE: finiteArea: consistent use of =delete for removed ctors/assignments
This commit is contained in:
Kutalmis Bercin
2024-01-19 15:44:04 +00:00
committed by Andrew Heather
parent 9de77857a6
commit b393d6eca1
63 changed files with 423 additions and 384 deletions

View File

@ -100,14 +100,14 @@ Foam::fac::interpolate
Istream& schemeData
)
{
# ifdef DEBUGInterpolations
#ifdef DEBUGInterpolations
if (edgeInterpolation::debug)
{
InfoInFunction
<< "interpolating GeometricField<Type, faPatchField, areaMesh> "
<< endl;
}
# endif
#endif
return scheme<Type>(faceFlux, schemeData)().interpolate(vf);
}
@ -122,7 +122,7 @@ Foam::fac::interpolate
const word& name
)
{
# ifdef DEBUGInterpolations
#ifdef DEBUGInterpolations
if (edgeInterpolation::debug)
{
InfoInFunction
@ -130,7 +130,7 @@ Foam::fac::interpolate
<< "using " << name
<< endl;
}
# endif
#endif
return scheme<Type>(faceFlux, name)().interpolate(vf);
}
@ -199,14 +199,14 @@ Foam::fac::interpolate
Istream& schemeData
)
{
# ifdef DEBUGInterpolations
#ifdef DEBUGInterpolations
if (edgeInterpolation::debug)
{
InfoInFunction
<< "interpolating GeometricField<Type, faPatchField, areaMesh> "
<< endl;
}
# endif
#endif
return scheme<Type>(vf.mesh(), schemeData)().interpolate(vf);
}
@ -220,7 +220,7 @@ Foam::fac::interpolate
const word& name
)
{
# ifdef DEBUGInterpolations
#ifdef DEBUGInterpolations
if (edgeInterpolation::debug)
{
InfoInFunction
@ -228,7 +228,7 @@ Foam::fac::interpolate
<< "using " << name
<< endl;
}
# endif
#endif
return scheme<Type>(vf.mesh(), name)().interpolate(vf);
}
@ -257,7 +257,7 @@ Foam::fac::interpolate
const GeometricField<Type, faPatchField, areaMesh>& vf
)
{
# ifdef DEBUGInterpolations
#ifdef DEBUGInterpolations
if (edgeInterpolation::debug)
{
InfoInFunction
@ -265,7 +265,7 @@ Foam::fac::interpolate
<< "using run-time selected scheme"
<< endl;
}
# endif
#endif
return interpolate(vf, "interpolate(" + vf.name() + ')');
}

View File

@ -129,6 +129,15 @@ public:
ClassName("edgeInterpolation");
// Generated Methods
//- No copy construct
edgeInterpolation(const edgeInterpolation&) = delete;
//- No copy assignment
void operator=(const edgeInterpolation&) = delete;
// Constructors
//- Construct given an faMesh
@ -142,10 +151,7 @@ public:
// Member Functions
//- Return mesh reference
const faMesh& mesh() const noexcept
{
return faMesh_;
}
const faMesh& mesh() const noexcept { return faMesh_; }
//- Return reference to PN geodesic distance
const edgeScalarField& lPN() const;

View File

@ -59,18 +59,12 @@ class edgeInterpolationScheme
:
public refCount
{
// Private data
// Private Data
//- Hold reference to mesh
//- Reference to mesh
const faMesh& mesh_;
// Private Member Functions
//- No copy assignment
void operator=(const edgeInterpolationScheme&) = delete;
public:
// Declare run-time constructor selection tables
@ -101,6 +95,15 @@ public:
);
// Private Member Functions
//- No copy construct
edgeInterpolationScheme(const edgeInterpolationScheme&) = delete;
//- No copy assignment
void operator=(const edgeInterpolationScheme&) = delete;
// Constructors
//- Construct from mesh
@ -179,10 +182,7 @@ public:
) const = 0;
//- Return true if this scheme uses an explicit correction
virtual bool corrected() const
{
return false;
}
virtual bool corrected() const { return false; }
//- Return the explicit correction to the face-interpolate
// for the given field

View File

@ -54,7 +54,11 @@ namespace Foam
class GammaWeight
{
scalar k_;
// Private Data
//- Model coefficient [0,1]
scalar k_;
public:

View File

@ -72,14 +72,6 @@ protected:
const edgeScalarField& edgeFlux_;
// Protected Member Functions
//- No copy construct
faNVDscheme(const faNVDscheme&) = delete;
//- No copy assignment
void operator=(const faNVDscheme&) = delete;
public:
@ -91,6 +83,15 @@ public:
TypeName("faNVDscheme");
// Generated Methods
//- No copy construct
faNVDscheme(const faNVDscheme&) = delete;
//- No copy assignment
void operator=(const faNVDscheme&) = delete;
// Constructors
//- Construct from mesh and edgeFlux and blendingFactor

View File

@ -56,26 +56,27 @@ class blendedEdgeInterpolation
public linearEdgeInterpolation<Type>,
public upwindEdgeInterpolation<Type>
{
// Private data
// Private Data
//- Blending factor
const scalar blendingFactor_;
// Private Member Functions
//- No copy construct
blendedEdgeInterpolation(const blendedEdgeInterpolation&) = delete;
//- No copy assignment
void operator=(const blendedEdgeInterpolation&) = delete;
public:
//- Runtime type information
TypeName("blended");
// Generated Methods
//- No copy construct
blendedEdgeInterpolation(const blendedEdgeInterpolation&) = delete;
//- No copy assignment
void operator=(const blendedEdgeInterpolation&) = delete;
// Constructors
//- Construct from mesh, faceFlux and blendingFactor

View File

@ -67,18 +67,22 @@ class leastSquaresEdgeInterpolation
:
virtual public edgeInterpolationScheme<Type>
{
// Private Member Functions
//- No copy assignment
void operator=(const leastSquaresEdgeInterpolation&) = delete;
public:
//- Runtime type information
TypeName("leastSquares");
// Generated Methods
//- No copy construct
leastSquaresEdgeInterpolation(const leastSquaresEdgeInterpolation&)
= delete;
//- No copy assignment
void operator=(const leastSquaresEdgeInterpolation&) = delete;
// Constructors
//- Construct from mesh

View File

@ -54,17 +54,21 @@ class linearEdgeInterpolation
:
virtual public edgeInterpolationScheme<Type>
{
// Private Member Functions
//- No copy assignment
void operator=(const linearEdgeInterpolation&) = delete;
public:
//- Runtime type information
TypeName("linear");
// Generated Methods
//- No copy construct
linearEdgeInterpolation(const linearEdgeInterpolation&) = delete;
//- No copy assignment
void operator=(const linearEdgeInterpolation&) = delete;
// Constructors
//- Construct from mesh

View File

@ -58,9 +58,17 @@ namespace Foam
class linearUpwindWeight
{
public:
// Generated Methods
//- No copy construct
linearUpwindWeight(const linearUpwindWeight&) = delete;
//- No copy assignment
void operator=(const linearUpwindWeight&) = delete;
linearUpwindWeight(Istream&)
{}

View File

@ -60,6 +60,7 @@ class skewCorrectedEdgeInterpolation
{
// Private Data
//- Edge-interpolation scheme
tmp<edgeInterpolationScheme<Type>> tScheme_;
@ -69,6 +70,16 @@ public:
TypeName("skewCorrected");
// Generated Methods
//- No copy construct
skewCorrectedEdgeInterpolation(const skewCorrectedEdgeInterpolation&)
= delete;
//- No copy assignment
void operator=(const skewCorrectedEdgeInterpolation&) = delete;
// Constructors
//- Construct from Istream
@ -96,13 +107,6 @@ public:
)
{}
//- No copy construct
skewCorrectedEdgeInterpolation(const skewCorrectedEdgeInterpolation&) =
delete;
//- No copy assignment
void operator=(const skewCorrectedEdgeInterpolation&) = delete;
// Member Functions
@ -115,7 +119,7 @@ public:
return tScheme_().weights(vf);
}
//- Return true if this scheme uses an explicit correction
//- Return true if this scheme uses an explicit correction
virtual bool corrected() const
{
return

View File

@ -55,23 +55,27 @@ class upwindEdgeInterpolation
:
virtual public edgeInterpolationScheme<Type>
{
// Private data
// Private Data
//- Face flux
const edgeScalarField& faceFlux_;
// Private Member Functions
//- No copy assignment
void operator=(const upwindEdgeInterpolation&) = delete;
public:
//- Runtime type information
TypeName("upwind");
// Generated Methods
//- No copy construct
upwindEdgeInterpolation(const upwindEdgeInterpolation&) = delete;
//- No copy assignment
void operator=(const upwindEdgeInterpolation&) = delete;
// Constructors
//- Construct from faceFlux