Corrected capitalization of Doxygen documentation comments

This commit is contained in:
Henry
2015-02-14 13:10:15 +00:00
parent fb68661de8
commit f58fd14271
268 changed files with 818 additions and 818 deletions

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -130,7 +130,7 @@ namespace Foam
//- initialise inotify
//- Initialise inotify
inline fileMonitorWatcher(const bool useInotify, const label sz = 20)
:
useInotify_(useInotify),
@ -179,7 +179,7 @@ namespace Foam
}
}
//- remove all watches
//- Remove all watches
inline ~fileMonitorWatcher()
{
#ifdef FOAM_USE_INOTIFY

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -105,13 +105,13 @@ public:
// Check
//- compare two fileStats for same device
//- Compare two fileStats for same device
bool sameDevice(const fileStat& stat2) const;
//- compare two fileStats for same Inode
//- Compare two fileStats for same Inode
bool sameINode(const fileStat& stat2) const;
//- compare state against inode
//- Compare state against inode
bool sameINode(const label iNode) const;

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -55,7 +55,7 @@ class sigStopAtWriteNow
{
// Private data
//- number of signal to use
//- Number of signal to use
static int signal_;
//- Saved old signal trapping setting

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -54,7 +54,7 @@ class sigWriteNow
{
// Private data
//- number of signal to use
//- Number of signal to use
static int signal_;
//- Saved old signal trapping setting

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -67,7 +67,7 @@ SourceFiles
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- check it a timeout has occured
//- Check it a timeout has occured
// keep setjmp in same stack frame so no function calls
#define timedOut(x) \
(((x).newTimeOut_ > 0) ? setjmp(Foam::timer::envAlarm) : false)
@ -83,16 +83,16 @@ class timer
{
// Private data
//- old signal masks
//- Old signal masks
static struct sigaction oldAction_;
//- old alarm() value
//- Old alarm() value
static unsigned int oldTimeOut_;
// Private Member Functions
//- alarm handler
//- Alarm handler
static void signalHandler(int);
@ -103,10 +103,10 @@ public:
//- Declare name of the class and its debug switch
ClassName("timer");
//- current time out value. Needed by macro timedOut
//- Current time out value. Needed by macro timedOut
unsigned int newTimeOut_;
//- state for setjmp. Needed by macro timedOut
//- State for setjmp. Needed by macro timedOut
static jmp_buf envAlarm;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -92,7 +92,7 @@ public:
//- Bounding box of this node
treeBoundBox bb_;
//- parent node (index into nodes_ of tree)
//- Parent node (index into nodes_ of tree)
label parent_;
//- IDs of the 8 nodes on all sides of the mid point

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -83,7 +83,7 @@ public:
//- Bounding box of this node
treeBoundBox bb_;
//- parent node (index into nodes_ of tree)
//- Parent node (index into nodes_ of tree)
label parent_;
//- IDs of the 8 nodes on all sides of the mid point

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -67,7 +67,7 @@ class treeDataCell
//- How to decide if point is inside cell
const polyMesh::cellRepresentation decompMode_;
//- cell bounding boxes (valid only if cacheBb_)
//- Cell bounding boxes (valid only if cacheBb_)
treeBoundBoxList bbs_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -461,7 +461,7 @@ public:
inline iterator operator++(int);
};
//- iterator set to the beginning of the HashTable
//- Iterator set to the beginning of the HashTable
inline iterator begin();

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -350,10 +350,10 @@ public:
};
//- iterator set to the beginning of the StaticHashTable
//- Iterator set to the beginning of the StaticHashTable
inline iterator begin();
//- iterator set to beyond the end of the StaticHashTable
//- Iterator set to beyond the end of the StaticHashTable
inline const iterator& end();
//- const_iterator set to the beginning of the StaticHashTable
@ -385,7 +385,7 @@ public:
private:
//- iterator returned by end()
//- Iterator returned by end()
iterator endIter_;
//- const_iterator returned by end()

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -302,7 +302,7 @@ public:
private:
//- iterator returned by end()
//- Iterator returned by end()
static iterator endIter_;
//- const_iterator returned by end()

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -249,7 +249,7 @@ public:
private:
//- iterator returned by end()
//- Iterator returned by end()
static iterator endIter_;
//- const_iterator returned by end()

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -544,10 +544,10 @@ public:
};
//- iterator set to the beginning of the PackedList
//- Iterator set to the beginning of the PackedList
inline iterator begin();
//- iterator set to beyond the end of the PackedList
//- Iterator set to beyond the end of the PackedList
inline iterator end();

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -182,7 +182,7 @@ public:
return index_ > vn.index_;
}
//- this version the same as or newer than the one given
//- This version the same as or newer than the one given
bool operator>=(const versionNumber& vn)
{
return index_ >= vn.index_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -101,13 +101,13 @@ class PstreamBuffers
const IOstream::versionNumber version_;
//- send buffer
//- Send buffer
List<DynamicList<char> > sendBuf_;
//- receive buffer
//- Receive buffer
List<DynamicList<char> > recvBuf_;
//- read position in recvBuf_
//- Read position in recvBuf_
labelList recvBufPos_;
bool finishedSendsCalled_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -97,10 +97,10 @@ protected:
const word& redirectType
) const;
//- get the loaded dynamic libraries
//- Get the loaded dynamic libraries
virtual dlLibraryTable& libs() const = 0;
//- adapt the context for the current object
//- Adapt the context for the current object
virtual void prepare
(
dynamicCode&,

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -121,10 +121,10 @@ class codedFixedValuePointPatchField
//- Set the rewrite vars controlling the Type
static void setFieldTemplates(dynamicCode& dynCode);
//- get the loaded dynamic libraries
//- Get the loaded dynamic libraries
virtual dlLibraryTable& libs() const;
//- adapt the context for the current object
//- Adapt the context for the current object
virtual void prepare(dynamicCode&, const dynamicCodeContext&) const;
// Return a description (type + name) for the output

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -57,7 +57,7 @@ class timeVaryingUniformFixedValuePointPatchField
{
// Private data
//- the time series being used, including the bounding treatment
//- The time series being used, including the bounding treatment
interpolationTable<Type> timeSeries_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -90,14 +90,14 @@ public:
};
//- reduce operator
//- Reduce operator
class combineConstraintsEqOp
{
public:
inline void operator()(pointConstraint&, const pointConstraint&) const;
};
//- transformation function
//- Transformation function
inline pointConstraint transform(const tensor& tt, const pointConstraint& v);
//- contiguous

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -134,7 +134,7 @@ class argList
const string& str
);
//- get rootPath_ / globalCase_ from one of the following forms
//- Get rootPath_ / globalCase_ from one of the following forms
// * [-case dir]
// * cwd
//

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -69,7 +69,7 @@ namespace electromagnetic
//- Magnetic flux quantum: default SI units: [Wb]
extern const dimensionedScalar phi0;
//- von Klitzing constant: default SI units: [ohm]
//- Von Klitzing constant: default SI units: [ohm]
extern const dimensionedScalar RK;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -196,7 +196,7 @@ bool ping(const string&, const label timeOut=10);
//- Execute the specified command
int system(const std::string& command);
//- open a shared library. Return handle to library. Print error message
//- Open a shared library. Return handle to library. Print error message
// if library cannot be loaded (check = true)
void* dlOpen(const fileName& lib, const bool check = true);

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -80,7 +80,7 @@ private:
//- File name
fileName fileName_;
//- the actual reader
//- The actual reader
autoPtr<tableReader<Type> > reader_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -103,7 +103,7 @@ private:
//- File name
fileName fileName_;
//- the actual reader
//- The actual reader
autoPtr<tableReader<Type> > reader_;
// Private Member Functions

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -110,7 +110,7 @@ public:
List<Tuple2<scalar, List<Tuple2<scalar, Type> > > >&
);
//- write the remaining parameters
//- Write the remaining parameters
virtual void write(Ostream& os) const;
};

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -119,7 +119,7 @@ public:
word fieldName_;
const LduMatrix<Type, DType, LUType>& matrix_;
//- dictionary of controls
//- Dictionary of controls
dictionary controlDict_;
//- Maximum number of iterations in the solver

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -101,7 +101,7 @@ public:
const FieldField<Field, scalar>& interfaceIntCoeffs_;
lduInterfaceFieldPtrsList interfaces_;
//- dictionary of controls
//- Dictionary of controls
dictionary controlDict_;
//- Maximum number of iterations in the solver

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -57,7 +57,7 @@ class SVD
//- Rectangular matrix with the same dimensions as the input
scalarRectangularMatrix U_;
//- square matrix V
//- Square matrix V
scalarRectangularMatrix V_;
//- The singular values

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -88,7 +88,7 @@ public:
// Member Functions
//- from neighbour processor to index in boundaryMesh. Local information
//- From neighbour processor to index in boundaryMesh. Local information
// (so not same over all processors)
const labelList& procPatchMap() const
{

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -98,7 +98,7 @@ public:
// Member Functions
//- order in which comms is scheduled
//- Order in which comms is scheduled
const labelList& schedule() const
{
return schedule_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -55,7 +55,7 @@ class hexMatcher
{
// Static data members
//- constants for this shape
//- Constants for this shape
static const label vertPerCell;
static const label facePerCell;
static const label maxVertPerFace;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -55,7 +55,7 @@ class prismMatcher
{
// Static data members
//- constants for this shape
//- Constants for this shape
static const label vertPerCell;
static const label facePerCell;
static const label maxVertPerFace;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -55,7 +55,7 @@ class pyrMatcher
{
// Static data members
//- constants for this shape
//- Constants for this shape
static const label vertPerCell;
static const label facePerCell;
static const label maxVertPerFace;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -55,7 +55,7 @@ class tetMatcher
{
// Static data members
//- constants for this shape
//- Constants for this shape
static const label vertPerCell;
static const label facePerCell;
static const label maxVertPerFace;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -55,7 +55,7 @@ class tetWedgeMatcher
{
// Static data members
//- constants for this shape
//- Constants for this shape
static const label vertPerCell;
static const label facePerCell;
static const label maxVertPerFace;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -55,7 +55,7 @@ class wedgeMatcher
{
// Static data members
//- constants for this shape
//- Constants for this shape
static const label vertPerCell;
static const label facePerCell;
static const label maxVertPerFace;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -121,7 +121,7 @@ public:
//- Return edge line
inline linePointRef line(const pointField&) const;
//- compare edges
//- Compare edges
// Returns:
// - 0: different
// - +1: identical

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -365,7 +365,7 @@ public:
faceList& quadFaces
) const;
//- compare faces
//- Compare faces
// 0: different
// +1: identical
// -1: same face, but different orientation

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -218,7 +218,7 @@ public:
// - 0: edge not found on the face
inline int edgeDirection(const edge&) const;
//- compare triFaces
//- Compare triFaces
// Returns:
// - 0: different
// - +1: identical

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -110,7 +110,7 @@ public:
// Queries relating to my processor (using world communicator)
//- my local size
//- My local size
inline label localSize() const;
//- From local to global

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -83,16 +83,16 @@ class mapAddedPolyMesh
//- From added mesh cells to new cells
labelList addedCellMap_;
//- original mesh to new mesh patch map. -1 for deleted patches.
//- Original mesh to new mesh patch map. -1 for deleted patches.
labelList oldPatchMap_;
//- added mesh to new mesh patch map. -1 for deleted patches.
//- Added mesh to new mesh patch map. -1 for deleted patches.
labelList addedPatchMap_;
//- original patch sizes on old mesh
//- Original patch sizes on old mesh
labelList oldPatchSizes_;
//- original patch starts
//- Original patch starts
labelList oldPatchStarts_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -96,7 +96,7 @@ public:
// Edit
//- distribute list of lagrangian data
//- Distribute list of lagrangian data
template<class T>
void distributeLagrangianData(List<T>& lst) const
{

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -208,28 +208,28 @@ public:
// Edit
//- distribute list of point data
//- Distribute list of point data
template<class T>
void distributePointData(List<T>& lst) const
{
pointMap_.distribute(lst);
}
//- distribute list of face data
//- Distribute list of face data
template<class T>
void distributeFaceData(List<T>& lst) const
{
faceMap_.distribute(lst);
}
//- distribute list of cell data
//- Distribute list of cell data
template<class T>
void distributeCellData(List<T>& lst) const
{
cellMap_.distribute(lst);
}
//- distribute list of patch data
//- Distribute list of patch data
template<class T>
void distributePatchData(List<T>& lst) const
{
@ -237,7 +237,7 @@ public:
}
//- distribute list of point/face/cell/patch indices.
//- Distribute list of point/face/cell/patch indices.
// (Converts to boolList, distributes boolList and reconstructs)
void distributePointIndices(labelList& pointIDs) const;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -90,7 +90,7 @@ public:
// Utility functions
//- labels of added patches
//- Labels of added patches
labelList addedPatches() const
{
labelList added(patchMap_.size());
@ -108,7 +108,7 @@ public:
return added;
}
//- labels (on old mesh) of deleted patches
//- Labels (on old mesh) of deleted patches
labelList deletedPatches() const
{
labelList oldToNew(nOldPatches_, -1);

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -136,11 +136,11 @@ private:
//- Communicator used for parallel communication
label comm_;
//- vector of non-constrained directions in mesh
//- Vector of non-constrained directions in mesh
// defined according to the presence of empty and wedge patches
mutable Vector<label> geometricD_;
//- vector of valid directions in mesh
//- Vector of valid directions in mesh
// defined according to the presence of empty patches
mutable Vector<label> solutionD_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -75,26 +75,26 @@ class tetIndices
{
// Private data
//- cell that this is a decomposed tet of
//- Cell that this is a decomposed tet of
label cellI_;
//- face that holds this decomposed tet
//- Face that holds this decomposed tet
label faceI_;
//- base point on the face
//- Base point on the face
label faceBasePtI_;
//- point on the face such that the right-hand circulation
//- Point on the face such that the right-hand circulation
// {faceBasePtI_, facePtAI_, facePtBI_}
// forms a triangle that points out of the tet
label facePtAI_;
//- point on the face such that the right-hand circulation
//- Point on the face such that the right-hand circulation
// {faceBasePtI_, facePtAI_, facePtBI_}
// forms a triangle that points out of the tet
label facePtBI_;
//- point on the face, *relative to the base point*, which
//- Point on the face, *relative to the base point*, which
// characterises this tet on the face.
label tetPtI_;

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -72,16 +72,16 @@ private:
// Private data
//- default matching tolerance
//- Default matching tolerance
static const scalar defaultMatchTol_;
//- local matching tolerance
//- Local matching tolerance
const scalar matchTolerance_;
//- Type of transformation
transformType transform_;
//- offset (distance) vector from one side of the couple to the other
//- Offset (distance) vector from one side of the couple to the other
mutable vectorField separation_;
//- Face transformation tensor

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -81,7 +81,7 @@ class cyclicPolyPatch
//- Axis of rotation for rotational cyclics
vector rotationAxis_;
//- point on axis of rotation for rotational cyclics
//- Point on axis of rotation for rotational cyclics
point rotationCentre_;
// For translation
@ -377,7 +377,7 @@ public:
return rotationAxis_;
}
//- point on axis of rotation for rotational cyclics
//- Point on axis of rotation for rotational cyclics
const point& rotationCentre() const
{
return rotationCentre_;

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -340,7 +340,7 @@ void Foam::oldCyclicPolyPatch::getCentresAndAnchors
break;
}
//- Problem: usually specified translation is not accurate enough
//- to get proper match so keep automatic determination over here.
//- To get proper match so keep automatic determination over here.
//case TRANSLATIONAL:
//{
// // Transform 0 points.

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -66,7 +66,7 @@ class oldCyclicPolyPatch
//- Axis of rotation for rotational cyclics
vector rotationAxis_;
//- point on axis of rotation for rotational cyclics
//- Point on axis of rotation for rotational cyclics
point rotationCentre_;
// For translation

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -46,7 +46,7 @@ namespace Foam
class objectRegistry;
//- preserve patch types
//- Preserve patch types
void preservePatchTypes
(
const objectRegistry& obr,

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -61,7 +61,7 @@ class PointIndexHit
//- Point of hit; invalid for misses
Point hitPoint_;
//- label of face hit
//- Label of face hit
label index_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -55,7 +55,7 @@ class pointHitSort
//- intersection
pointHit inter_;
//- original index
//- Original index
label index_;
public:

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -202,7 +202,7 @@ public:
//- Typical dimension length,height,width
inline scalar typDim() const;
//- vertex coordinates. In octant coding.
//- Vertex coordinates. In octant coding.
tmp<pointField> points() const;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -106,7 +106,7 @@ public:
// Operators
//- perp dot product (dot product with perpendicular vector)
//- Perp dot product (dot product with perpendicular vector)
inline scalar perp(const Vector2D<Cmpt>& b) const;
};

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -124,7 +124,7 @@ private:
void determineTransformPermutations();
//- Determine which patch uses which transform (if any) and which
//- sign to use
//- Sign to use
void determinePatchTransformSign();
//- Test a list of reference transforms to see if the test

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -187,7 +187,7 @@ Description
// acceptable. Do NOT use for cryptographic purposes.
// ----------------------------------------------------------------------------
//- specialized little-endian code
//- Specialized little-endian code
#if !defined (__BYTE_ORDER) || (__BYTE_ORDER == __LITTLE_ENDIAN)
static unsigned jenkins_hashlittle
(

View File

@ -69,7 +69,7 @@ bool read(const char*, int32_t&);
Istream& operator>>(Istream&, int32_t&);
Ostream& operator<<(Ostream&, const int32_t);
//- template specialization for pTraits<int32_t>
//- Template specialization for pTraits<int32_t>
template<>
class pTraits<int32_t>
{

View File

@ -69,7 +69,7 @@ bool read(const char*, int64_t&);
Istream& operator>>(Istream&, int64_t&);
Ostream& operator<<(Ostream&, const int64_t);
//- template specialization for pTraits<int64_t>
//- Template specialization for pTraits<int64_t>
template<>
class pTraits<int64_t>
{

View File

@ -69,7 +69,7 @@ bool read(const char*, uint32_t&);
Istream& operator>>(Istream&, uint32_t&);
Ostream& operator<<(Ostream&, const uint32_t);
//- template specialization for pTraits<uint32_t>
//- Template specialization for pTraits<uint32_t>
template<>
class pTraits<uint32_t>
{

View File

@ -69,7 +69,7 @@ bool read(const char*, uint64_t&);
Istream& operator>>(Istream&, uint64_t&);
Ostream& operator<<(Ostream&, const uint64_t);
//- template specialization for pTraits<uint64_t>
//- Template specialization for pTraits<uint64_t>
template<>
class pTraits<uint64_t>
{

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -67,10 +67,10 @@ public:
int bit();
//- scalar [0..1] (so including 0,1)
//- Scalar [0..1] (so including 0,1)
scalar scalar01();
//- vector with every component scalar01
//- Vector with every component scalar01
vector vector01();
//- sphericalTensor with every component scalar01
@ -79,10 +79,10 @@ public:
//- symmTensor with every component scalar01
symmTensor symmTensor01();
//- tensor with every component scalar01
//- Tensor with every component scalar01
tensor tensor01();
//- label [lower..upper]
//- Label [lower..upper]
label integer(const label lower, const label upper);
vector position(const vector&, const vector&);

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -66,7 +66,7 @@ class hashedWordList
// Private Member Functions
//- rebuild the hash of indices
//- Rebuild the hash of indices
void rehash();
public:

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -133,7 +133,7 @@ public:
//- Sort the axes such that they are closest to the x, y and z axes
triad sortxyz() const;
//- convert to a quaternion
//- Convert to a quaternion
operator quaternion() const;

View File

@ -198,7 +198,7 @@ void turbulentHeatFluxTemperatureFvPatchScalarField::updateCoeffs()
scalarField qr(this->size(), 0.0);
//- qr is negative going into the domain
//- Qr is negative going into the domain
if (QrName_ != "none")
{
qr = patch().lookupPatchField<volScalarField, scalar>(QrName_);

View File

@ -4,7 +4,7 @@
{
labelList cellBoundaryFaceCount(epsilon_.size(), 0);
//- use constant Cmu for epsilon in the near-wall cell
//- Use constant Cmu for epsilon in the near-wall cell
scalar Cmu75 = pow(CmuWall_.value(), 0.75);
const fvPatchList& patches = mesh_.boundary();

View File

@ -4,7 +4,7 @@
{
labelList cellBoundaryFaceCount(epsilon_.size(), 0);
//- use constant Cmu for epsilon in the near-wall cell
//- Use constant Cmu for epsilon in the near-wall cell
scalar Cmu75 = pow(Cmu_.value(), 0.75);
const fvPatchList& patches = mesh_.boundary();

View File

@ -82,7 +82,7 @@ Description
{
label faceCelli = curPatch.faceCells()[facei];
//- using local Cmu !
//- Using local Cmu !
scalar Cmu25 = pow025(Cmu_[faceCelli]);
scalar Cmu75 = pow(Cmu_[faceCelli], 0.75);

View File

@ -137,7 +137,7 @@ class atmBoundaryLayer
//- Direction of the z-coordinate
vector zDir_;
//- von Karman constant
//- Von Karman constant
const scalar kappa_;
//- Turbulent viscosity coefficient

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -95,7 +95,7 @@ class turbulentMixingLengthDissipationRateInletFvPatchScalarField
{
// Private data
//- turbulent length scale
//- Turbulent length scale
scalar mixingLength_;
//- Name of the turbulent kinetic energy field

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -51,10 +51,10 @@ class ensightFile
{
// Private data
//- allow undef in results
//- Allow undef in results
static bool allowUndef_;
//- value to represent undef in results
//- Value to represent undef in results
static scalar undefValue_;
//- The '*' mask appropriate for subDir
@ -120,28 +120,28 @@ public:
// Output
//- binary write
//- Binary write
virtual Ostream& write(const char* buf, std::streamsize count);
//- write element keyword with trailing newline, optionally with undef
//- Write element keyword with trailing newline, optionally with undef
virtual Ostream& writeKeyword(const string& key);
//- write "C Binary" for binary files (eg, geometry/measured)
//- Write "C Binary" for binary files (eg, geometry/measured)
Ostream& writeBinaryHeader();
//- write undef value
//- Write undef value
Ostream& writeUndef();
//- write string as "%80s" or as binary
//- Write string as "%80s" or as binary
Ostream& write(const string& value);
//- write integer as "%10d" or as binary
//- Write integer as "%10d" or as binary
Ostream& write(const label value);
//- write integer with specified width or as binary
//- Write integer with specified width or as binary
Ostream& write(const label value, const label fieldWidth);
//- write float as "%12.5e" or as binary
//- Write float as "%12.5e" or as binary
Ostream& write(const scalar value);
//- Add carriage return to ascii stream

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -74,7 +74,7 @@ public:
// Output
//- write keyword with trailing newline
//- Write keyword with trailing newline
virtual Ostream& writeKeyword(const string& key);
};

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -67,25 +67,25 @@ protected:
// Protected data
//- part number
//- Part number
label number_;
//- part name (or description)
//- Part name (or description)
string name_;
//- simple labelList with a name
//- Simple labelList with a name
labelListList elemLists_;
//- start offset for elemLists_
//- Start offset for elemLists_
label offset_;
//- number of elements in this part
//- Number of elements in this part
label size_;
//- cell or face data
//- Cell or face data
bool isCellData_;
//- material id (numeric)
//- Material id (numeric)
label matId_;
//- pointField referenced
@ -94,24 +94,24 @@ protected:
// Protected Classes
//- track the points used by the part and map global to local indices
//- Track the points used by the part and map global to local indices
class localPoints
{
public:
//- number of points used
//- Number of points used
label nPoints;
//- map global to local indices
//- Map global to local indices
labelList list;
//- null constructor
//- Null constructor
localPoints()
:
nPoints(0),
list(0)
{}
//- construct for mesh points
//- Construct for mesh points
localPoints(const pointField& pts)
:
nPoints(0),
@ -127,13 +127,13 @@ protected:
// but cannot be used to write a new geometry
void reconstruct(Istream&);
//- check for fully defined fields
//- Check for fully defined fields
bool isFieldDefined(const List<scalar>&) const;
//- write the part header
//- Write the part header
void writeHeader(ensightFile&, bool withDescription=false) const;
//- write a scalar field for idList
//- Write a scalar field for idList
// A null reference for idList writes the perNode values
void writeFieldList
(
@ -142,13 +142,13 @@ protected:
const labelUList& idList
) const;
//- track points used
//- Track points used
virtual localPoints calcLocalPoints() const
{
return localPoints();
}
//- write connectivities
//- Write connectivities
virtual void writeConnectivity
(
ensightGeoFile&,
@ -224,37 +224,37 @@ public:
// Access
//- number of elements in this part
//- Number of elements in this part
label size() const
{
return size_;
}
//- represents cell data
//- Represents cell data
bool isCellData() const
{
return isCellData_;
}
//- represents face data
//- Represents face data
bool isFaceData() const
{
return !isCellData_;
}
//- part number
//- Part number
label number() const
{
return number_;
}
//- part name or description
//- Part name or description
const string& name() const
{
return name_;
}
//- material id
//- Material id
label materialId() const
{
return matId_;
@ -272,13 +272,13 @@ public:
matId_ = value;
}
//- simple labelList with a name
//- Simple labelList with a name
const labelListList& elemLists() const
{
return elemLists_;
}
//- offset for element ids
//- Offset for element ids
label offset() const
{
return offset_;
@ -287,13 +287,13 @@ public:
// Edit
//- renumber elements
//- Renumber elements
void renumber(const labelUList&);
//- write summary information about the object
//- Write summary information about the object
bool writeSummary(Ostream&) const;
//- write reconstruction information for the object
//- Write reconstruction information for the object
bool writeData(Ostream&) const;
//- Write geometry
@ -303,7 +303,7 @@ public:
//- Helper: write geometry given the pointField
void writeGeometry(ensightGeoFile&, const pointField&) const;
//- write scalar field
//- Write scalar field
// optionally write data per node
void writeScalarField
(
@ -312,7 +312,7 @@ public:
const bool perNode = false
) const;
//- write vector field components
//- Write vector field components
// optionally write data per node
void writeVectorField
(
@ -324,7 +324,7 @@ public:
) const;
//- write generalized field components
//- Write generalized field components
// optionally write data per node
template<class Type>
void writeField
@ -346,10 +346,10 @@ public:
// IOstream Operators
//- write data (reconstruction information)
//- Write data (reconstruction information)
friend Ostream& operator<<(Ostream&, const ensightPart&);
//- write geometry
//- Write geometry
friend ensightGeoFile& operator<<(ensightGeoFile&, const ensightPart&);
};

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -63,13 +63,13 @@ class ensightPartCells
const labelUList& idLabels = labelUList::null()
);
//- track points used
//- Track points used
virtual localPoints calcLocalPoints() const;
//- track the points used
//- Track the points used
// virtual void makeLocalPointMap();
//- element connectivity
//- Element connectivity
virtual void writeConnectivity
(
ensightGeoFile&,
@ -81,7 +81,7 @@ class ensightPartCells
protected:
//- addressable ensight element types
//- Addressable ensight element types
enum elemType
{
tetra4Elements,
@ -99,7 +99,7 @@ protected:
// Protected data
//- mesh referenced
//- Mesh referenced
const polyMesh& mesh_;
@ -154,10 +154,10 @@ public:
// Member Functions
//- write geometry
//- Write geometry
virtual void writeGeometry(ensightGeoFile&) const;
//- static listing of the element types
//- Static listing of the element types
virtual const List<word>& elementTypes() const
{
return elemTypes_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -55,10 +55,10 @@ class ensightPartFaces
//- Disallow default bitwise assignment
void operator=(const ensightPartFaces&);
//- track points used
//- Track points used
virtual localPoints calcLocalPoints() const;
//- element connectivity
//- Element connectivity
virtual void writeConnectivity
(
ensightGeoFile&,
@ -70,7 +70,7 @@ class ensightPartFaces
protected:
//- addressable ensight element types
//- Addressable ensight element types
enum elemType
{
tria3Elements,
@ -86,7 +86,7 @@ protected:
// Protected data
//- faces referenced
//- Faces referenced
const faceList& faces_;
//- Can skip local point renumbering when points are contiguous
@ -160,10 +160,10 @@ public:
// Member Functions
//- write geometry
//- Write geometry
virtual void writeGeometry(ensightGeoFile&) const;
//- static listing of the element types
//- Static listing of the element types
virtual const List<word>& elementTypes() const
{
return elemTypes_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -54,7 +54,7 @@ class ensightParts
{
// Private Data
//- list of parts
//- List of parts
PtrList<ensightPart> partsList_;
// Private Member Functions
@ -83,32 +83,32 @@ public:
// Member functions
//- clear old information and construct anew from polyMesh
//- Clear old information and construct anew from polyMesh
void recalculate(const polyMesh&);
//- renumber elements
//- Renumber elements
void renumber
(
const labelUList& origCellId,
const labelUList& origFaceId
);
//- number of parts
//- Number of parts
label size() const
{
return partsList_.size();
}
//- write the geometry
//- Write the geometry
void writeGeometry(ensightGeoFile&) const;
//- write summary information about the objects
//- Write summary information about the objects
bool writeSummary(Ostream&) const;
//- write the lists
//- Write the lists
void writeData(Ostream&) const;
//- write (volume) scalar field
//- Write (volume) scalar field
// optionally write data for face parts
// optionally write data per node
void writeScalarField
@ -119,7 +119,7 @@ public:
const bool perNode = false
) const;
//- write (volume) vector field components
//- Write (volume) vector field components
// optionally write data for face parts
// optionally write data per node
void writeVectorField
@ -133,7 +133,7 @@ public:
) const;
//- write generalized volume field components
//- Write generalized volume field components
template<class Type>
void writeField
(
@ -144,7 +144,7 @@ public:
// Friend Operators
//- write geometry
//- Write geometry
friend ensightGeoFile& operator<<(ensightGeoFile&, const ensightParts&);
};

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -154,10 +154,10 @@ private:
labelList patchStarts_;
labelList patchSizes_;
//- association between two faces
//- Association between two faces
List<labelPair> interfaces_;
//- list of cells/faces id pairs for each baffle
//- List of cells/faces id pairs for each baffle
List<List<cellFaceIdentifier> > baffleIds_;
//- Global face list for polyMesh

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -149,7 +149,7 @@ void Foam::meshReaders::STARCD::readPoints
points_.setSize(nPoints);
mapToFoamPointId_.setSize(maxId+1);
//- original Point number for a given vertex
//- Original Point number for a given vertex
// might need again in the future
//// labelList origPointId(nPoints);
//// origPointId = -1;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -173,7 +173,7 @@ public:
const fileName& instance = "constant"
);
//- write constant/cellTable for later reuse
//- Write constant/cellTable for later reuse
void writeDict
(
const objectRegistry&,

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -87,16 +87,16 @@ class boundaryMesh
// Edge handling
//
//- points referenced by feature edges.
//- Points referenced by feature edges.
pointField featurePoints_;
//- feature edges. Indices into featurePoints.
//- Feature edges. Indices into featurePoints.
edgeList featureEdges_;
//- from feature edge to mesh edge.
//- From feature edge to mesh edge.
labelList featureToEdge_;
//- from mesh edges to featureEdges_;
//- From mesh edges to featureEdges_;
labelList edgeToFeature_;
//- Feature 'segments'. Collections of connected featureEdges.

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -435,7 +435,7 @@ class cellCuts
//- Set orientation of loops
void orientPlanesAndLoops();
//- top level driver: adressing calculation and loop detection
//- Top level driver: adressing calculation and loop detection
void calcLoopsAndAddressing(const labelList& cutCells);
//- Check various consistencies.

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -74,7 +74,7 @@ private:
// Private Member Functions
//- walk across faces of hex. Update loop/loopWeights with edges cut.
//- Walk across faces of hex. Update loop/loopWeights with edges cut.
// Return true if successful walk. (should be always!)
bool walkHex
(

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -80,7 +80,7 @@ class topoCellLooper
DynamicList<T>& lst
);
//- walk across superface discarding non-feature points.
//- Walk across superface discarding non-feature points.
void walkFace
(
const cellFeatures& features,
@ -158,7 +158,7 @@ public:
// Static data members
//- cos of angle for feature recognition (of splitHexes)
//- Cos of angle for feature recognition (of splitHexes)
static const scalar featureCos;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -104,7 +104,7 @@ public:
// EdgeVertex handling
//- is eVert an edge?
//- Is eVert an edge?
static bool isEdge(const primitiveMesh& mesh, const label eVert)
{
if (eVert < 0 || eVert >= (mesh.nPoints() + mesh.nEdges()))
@ -125,7 +125,7 @@ public:
return isEdge(mesh_, eVert);
}
//- convert eVert to edge label
//- Convert eVert to edge label
static label getEdge(const primitiveMesh& mesh, const label eVert)
{
if (!isEdge(mesh, eVert))
@ -143,7 +143,7 @@ public:
return getEdge(mesh_, eVert);
}
//- convert eVert to vertex label
//- Convert eVert to vertex label
static label getVertex(const primitiveMesh& mesh, const label eVert)
{
if (isEdge(mesh, eVert) || (eVert < 0))

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -79,7 +79,7 @@ class multiDirRefinement
//- Current set of cells to refine. Extended with added cells.
labelList cellLabels_;
//- from original to added cells.
//- From original to added cells.
// Gives for every cell in the original mesh an empty list or the
// list of cells this one has been split into (note: will include
// itself so e.g. for hex will be 8 if 2x2x2 refinement)

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -67,10 +67,10 @@ public:
//- Null
refineCell();
//- from components. Vector will be normalized upon construction.
//- From components. Vector will be normalized upon construction.
refineCell(const label, const vector&);
//- from Istream. Vector will be normalized upon construction.
//- From Istream. Vector will be normalized upon construction.
refineCell(Istream& is);

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -213,7 +213,7 @@ class motionSmootherAlgo
//- Calculate per-edge weight
tmp<scalarField> calcEdgeWeights(const pointField&) const;
//- explicit smoothing and min on all affected internal points
//- Explicit smoothing and min on all affected internal points
void minSmooth
(
const scalarField& edgeWeights,
@ -222,7 +222,7 @@ class motionSmootherAlgo
pointScalarField& newFld
) const;
//- same but only on selected points (usually patch points)
//- Same but only on selected points (usually patch points)
void minSmooth
(
const scalarField& edgeWeights,

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -288,7 +288,7 @@ public:
const labelListList& layerFaces
);
//- added cells given current mesh & layerfaces.
//- Added cells given current mesh & layerfaces.
labelListList addedCells() const;

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -90,7 +90,7 @@ class hexRef8
//- Level of saved cells
Map<label> savedCellLevel_;
//- cell shapes when seen as split hexes
//- Cell shapes when seen as split hexes
mutable autoPtr<cellShapeList> cellShapesPtr_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -57,10 +57,10 @@ class refinementDistanceData
// Private data
//- unrefined (level0) buffer size (nBufferLayers*level0Size)
//- Unrefined (level0) buffer size (nBufferLayers*level0Size)
scalar level0Size_;
//- nearest point with highest level
//- Nearest point with highest level
point origin_;
label originLevel_;

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -106,7 +106,7 @@ public:
// -2: free splitCell (so should also be in freeSplitCells_)
label parent_;
//- cells this cell was refined into
//- Cells this cell was refined into
autoPtr<FixedList<label, 8> > addedCellsPtr_;
//- Construct null (parent = -1)

View File

@ -92,7 +92,7 @@ class engineTime
//- Disallow default bitwise assignment
void operator=(const engineTime&);
//- adjust read time values
//- Adjust read time values
void timeAdjustment();
public:

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -168,13 +168,13 @@ private:
// Data
//- cell based fields
//- Cell based fields
objectRegistry cellData_;
//- point based fields
//- Point based fields
objectRegistry pointData_;
//- other fields
//- Other fields
objectRegistry otherData_;
@ -317,7 +317,7 @@ public:
return lineMap_;
}
//- cell based fields
//- Cell based fields
const objectRegistry& cellData() const
{
return cellData_;
@ -328,7 +328,7 @@ public:
return cellData_;
}
//- point based fields
//- Point based fields
const objectRegistry& pointData() const
{
return pointData_;
@ -339,7 +339,7 @@ public:
return pointData_;
}
//- other fields
//- Other fields
const objectRegistry& otherData() const
{
return otherData_;

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -64,10 +64,10 @@ private:
// Private data
//- alpha coefficient XYZ components (user-supplied) [1/s]
//- Alpha coefficient XYZ components (user-supplied) [1/s]
dimensionedVector alphaXYZ_;
//- beta coefficient XYZ components (user-supplied) [1/m]
//- Beta coefficient XYZ components (user-supplied) [1/m]
dimensionedVector betaXYZ_;
//- Model alpha coefficient - converted from alphaXYZ [1/s]

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -124,10 +124,10 @@ class codedFixedValueFvPatchField
//- Set the rewrite vars controlling the Type
static void setFieldTemplates(dynamicCode& dynCode);
//- get the loaded dynamic libraries
//- Get the loaded dynamic libraries
virtual dlLibraryTable& libs() const;
//- adapt the context for the current object
//- Adapt the context for the current object
virtual void prepare(dynamicCode&, const dynamicCodeContext&) const;
// Return a description (type + name) for the output

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -134,10 +134,10 @@ class codedMixedFvPatchField
//- Set the rewrite vars controlling the Type
static void setFieldTemplates(dynamicCode& dynCode);
//- get the loaded dynamic libraries
//- Get the loaded dynamic libraries
virtual dlLibraryTable& libs() const;
//- adapt the context for the current object
//- Adapt the context for the current object
virtual void prepare(dynamicCode&, const dynamicCodeContext&) const;
// Return a description (type + name) for the output

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -100,10 +100,10 @@ class syringePressureFvPatchScalarField
{
// Private data
//- syringe piston area
//- Syringe piston area
scalar Ap_;
//- syringe piston speed
//- Syringe piston speed
scalar Sp_;
//- Initial syringe volume
@ -118,7 +118,7 @@ class syringePressureFvPatchScalarField
//- Start of piston deceleration
scalar tds_;
//- end of piston deceleration
//- End of piston deceleration
scalar tde_;
//- Initial syringe pressure

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -111,13 +111,13 @@ public:
return cellI_;
}
//- interpolation weights
//- Interpolation weights
inline const List<scalar>& weights() const
{
return weights_;
}
//- interpolation addressing for points on face
//- Interpolation addressing for points on face
inline const List<label>& faceVertices() const
{
return faceVertices_;

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-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -132,7 +132,7 @@ public:
return cellIndex_;
}
//- interpolation weights (in order of cellPoints)
//- Interpolation weights (in order of cellPoints)
inline const scalarField& weights() const
{
return weights_;

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -51,7 +51,7 @@ class motionDiffusivity
{
// Private data
//- mesh reference
//- Mesh reference
const fvMesh& mesh_;
public:

Some files were not shown because too many files have changed in this diff Show More