Standardised the class declaration section comments to correspond to the foamNewSource template

This commit is contained in:
Henry Weller
2019-06-13 21:26:33 +01:00
parent 47d19548c1
commit 8e9f692aa4
1863 changed files with 3798 additions and 3970 deletions

View File

@ -59,7 +59,7 @@ class displacementInterpolationMotionSolver
:
public points0MotionSolver
{
// Private data
// Private Data
// Face zone information (note: could pack these to only contain
// used zones)

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -63,7 +63,7 @@ Ostream& operator<<(Ostream&, const pointEdgeStructuredWalk&);
class pointEdgeStructuredWalk
{
// Private data
// Private Data
//- Starting location
point point0_;

View File

@ -73,7 +73,7 @@ class displacementLinearMotionMotionSolver
:
public points0MotionSolver
{
// Private data
// Private Data
//- Axis of the linear motion
vector axis_;

View File

@ -53,7 +53,7 @@ class interpolatingSolidBodyMotionSolver
:
public points0MotionSolver
{
// Private data
// Private Data
//- The motion control function
autoPtr<solidBodyMotionFunction> SBMFPtr_;

View File

@ -52,7 +52,7 @@ class multiSolidBodyMotionSolver
:
public points0MotionSolver
{
// Private data
// Private Data
//- The motion control function
PtrList<solidBodyMotionFunction> SBMFs_;

View File

@ -52,7 +52,7 @@ class solidBodyMotionDisplacementPointPatchVectorField
:
public fixedValuePointPatchVectorField
{
// Private data
// Private Data
//- The motion control function
autoPtr<solidBodyMotionFunction> SBMFPtr_;
@ -135,7 +135,7 @@ public:
}
// Member functions
// Member Functions
// Access

View File

@ -58,7 +58,7 @@ class SDA
:
public solidBodyMotionFunction
{
// Private data
// Private Data
//- Center of gravity
vector CofG_;

View File

@ -55,7 +55,7 @@ class axisRotationMotion
:
public solidBodyMotionFunction
{
// Private data
// Private Data
//- Origin
point origin_;

View File

@ -54,7 +54,7 @@ class linearMotion
:
public solidBodyMotionFunction
{
// Private data
// Private Data
//- Linear velocity
vector velocity_;

View File

@ -54,7 +54,7 @@ class multiMotion
:
public solidBodyMotionFunction
{
// Private data
// Private Data
//- Motions to combine
PtrList<solidBodyMotionFunction> SBMFs_;

View File

@ -54,7 +54,7 @@ class oscillatingLinearMotion
:
public solidBodyMotionFunction
{
// Private data
// Private Data
//- Amplitude
vector amplitude_;

View File

@ -54,7 +54,7 @@ class oscillatingRotatingMotion
:
public solidBodyMotionFunction
{
// Private data
// Private Data
//- Centre of gravity
point origin_;

View File

@ -59,7 +59,7 @@ class rotatingMotion
:
public solidBodyMotionFunction
{
// Private data
// Private Data
//- Origin of the axis
const vector origin_;

View File

@ -58,7 +58,7 @@ class tabulated6DoFMotion
:
public solidBodyMotionFunction
{
// Private data
// Private Data
//- Time data file name read from dictionary
fileName timeDataFileName_;

View File

@ -52,7 +52,7 @@ class solidBodyMotionSolver
:
public points0MotionSolver
{
// Private data
// Private Data
//- The motion control function
autoPtr<solidBodyMotionFunction> SBMFPtr_;

View File

@ -55,7 +55,7 @@ class mapPolyMesh;
class motionSolver
{
// Private data
// Private Data
//- Reference to mesh
const polyMesh& mesh_;

View File

@ -54,7 +54,7 @@ class motionSolverList
:
public motionSolver
{
// Private data
// Private Data
PtrList<motionSolver> motionSolvers_;