mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
Corrected capitalization of Doxygen documentation comments
This commit is contained in:
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2013-2014 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -69,7 +69,7 @@ private:
|
||||
|
||||
protected:
|
||||
|
||||
//- local typedef to octree tree-type
|
||||
//- Local typedef to octree tree-type
|
||||
typedef treeDataPrimitivePatch<TargetPatch> treeType;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -313,7 +313,7 @@ public:
|
||||
//- Axis of rotation for rotational cyclic AMI
|
||||
inline const vector& rotationAxis() const;
|
||||
|
||||
//- point on axis of rotation for rotational cyclic AMI
|
||||
//- Point on axis of rotation for rotational cyclic AMI
|
||||
inline const point& rotationCentre() const;
|
||||
|
||||
//- Translation vector for translational cyclic AMI
|
||||
|
||||
@ -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
|
||||
@ -59,10 +59,10 @@ class patchEdgeFaceInfo
|
||||
{
|
||||
// Private data
|
||||
|
||||
//- position of nearest wall center
|
||||
//- Position of nearest wall center
|
||||
point origin_;
|
||||
|
||||
//- normal distance (squared) from point to origin
|
||||
//- Normal distance (squared) from point to origin
|
||||
scalar distSqr_;
|
||||
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2013 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -59,7 +59,7 @@ class patchEdgeFaceRegions
|
||||
{
|
||||
// Private data
|
||||
|
||||
//- region per point
|
||||
//- Region per point
|
||||
labelList regions_;
|
||||
|
||||
public:
|
||||
|
||||
@ -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
|
||||
@ -61,10 +61,10 @@ class pointEdgePoint
|
||||
{
|
||||
// Private data
|
||||
|
||||
//- position of nearest wall center
|
||||
//- Position of nearest wall center
|
||||
point origin_;
|
||||
|
||||
//- normal distance (squared) from point to origin
|
||||
//- Normal distance (squared) from point to origin
|
||||
scalar distSqr_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -65,10 +65,10 @@ class wallPoint
|
||||
{
|
||||
// Private data
|
||||
|
||||
//- position of nearest wall center
|
||||
//- Position of nearest wall center
|
||||
point origin_;
|
||||
|
||||
//- normal distance (squared) from cellcenter to origin
|
||||
//- Normal distance (squared) from cellcenter to origin
|
||||
scalar distSqr_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -65,7 +65,7 @@ class wallPointData
|
||||
{
|
||||
// Private data
|
||||
|
||||
//- data at nearest wall center
|
||||
//- Data at nearest wall center
|
||||
Type data_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -65,7 +65,7 @@ class cellFeatures
|
||||
|
||||
const primitiveMesh& mesh_;
|
||||
|
||||
//- cos of angle between two connected faces or two connected edges on
|
||||
//- Cos of angle between two connected faces or two connected edges on
|
||||
// same face before edge/point is 'feature'.
|
||||
scalar minCos_;
|
||||
|
||||
|
||||
@ -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
|
||||
@ -70,7 +70,7 @@ class axesRotation
|
||||
//- Global-to-Local transformation tensor
|
||||
tensor Rtr_;
|
||||
|
||||
//- the combination of local axes to be used
|
||||
//- The combination of local axes to be used
|
||||
enum axisOrder
|
||||
{
|
||||
e1e2,
|
||||
@ -210,7 +210,7 @@ public:
|
||||
|
||||
// Member Operators
|
||||
|
||||
//- assign from dictionary
|
||||
//- Assign from dictionary
|
||||
void operator=(const dictionary&);
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -132,7 +132,7 @@ public:
|
||||
//- Return the table of contents (list of all keywords)
|
||||
wordList toc() const;
|
||||
|
||||
//- write data
|
||||
//- Write data
|
||||
bool writeData(Ostream&, bool subDict=true) const;
|
||||
};
|
||||
|
||||
|
||||
@ -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
|
||||
@ -88,7 +88,7 @@ class edgeFaceCirculator
|
||||
{
|
||||
// Static data members
|
||||
|
||||
//- end iterator
|
||||
//- End iterator
|
||||
static const edgeFaceCirculator endConstIter;
|
||||
|
||||
|
||||
@ -187,13 +187,13 @@ public:
|
||||
//- Step to next face. Uses no edge addressing!
|
||||
inline edgeFaceCirculator& operator++();
|
||||
|
||||
//- iterator set to the beginning face. For internal edges this is
|
||||
//- Iterator set to the beginning face. For internal edges this is
|
||||
// the current face. For boundary edges this is the first boundary face
|
||||
// reached from walking back (i.e. in opposite direction to ++)
|
||||
inline edgeFaceCirculator begin() const;
|
||||
inline edgeFaceCirculator cbegin() const;
|
||||
|
||||
//- iterator set to beyond the end of the walk.
|
||||
//- Iterator set to beyond the end of the walk.
|
||||
inline const edgeFaceCirculator& end() const;
|
||||
inline const edgeFaceCirculator& cend() const;
|
||||
};
|
||||
|
||||
@ -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
|
||||
@ -55,7 +55,7 @@ class treeDataEdge
|
||||
{
|
||||
// Static data
|
||||
|
||||
//- tolerance on linear dimensions
|
||||
//- Tolerance on linear dimensions
|
||||
static scalar tol;
|
||||
|
||||
|
||||
@ -67,13 +67,13 @@ class treeDataEdge
|
||||
//- Reference to points
|
||||
const pointField& points_;
|
||||
|
||||
//- labels of edges
|
||||
//- Labels of edges
|
||||
const labelList edgeLabels_;
|
||||
|
||||
//- Whether to precalculate and store face bounding box
|
||||
const bool cacheBb_;
|
||||
|
||||
//- bbs for all above edges (valid only if cacheBb_)
|
||||
//- Bbs for all above edges (valid only if cacheBb_)
|
||||
treeBoundBoxList bbs_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -60,7 +60,7 @@ class treeDataFace
|
||||
{
|
||||
// Static data
|
||||
|
||||
//- tolerance on linear dimensions
|
||||
//- Tolerance on linear dimensions
|
||||
static scalar tolSqr;
|
||||
|
||||
|
||||
@ -78,7 +78,7 @@ class treeDataFace
|
||||
//- Whether to precalculate and store face bounding box
|
||||
const bool cacheBb_;
|
||||
|
||||
//- face bounding boxes (valid only if cacheBb_)
|
||||
//- Face bounding boxes (valid only if cacheBb_)
|
||||
treeBoundBoxList bbs_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -74,7 +74,7 @@ class treeDataPrimitivePatch
|
||||
//- Tolerance to use for intersection tests
|
||||
const scalar planarTol_;
|
||||
|
||||
//- face bounding boxes (valid only if cacheBb_)
|
||||
//- Face bounding boxes (valid only if cacheBb_)
|
||||
treeBoundBoxList bbs_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -65,10 +65,10 @@ class meshSearch
|
||||
//- Whether to use cell decomposition for all geometric tests
|
||||
const polyMesh::cellRepresentation cellDecompMode_;
|
||||
|
||||
//- data bounding box
|
||||
//- Data bounding box
|
||||
mutable autoPtr<treeBoundBox> overallBbPtr_;
|
||||
|
||||
//- demand driven octrees
|
||||
//- Demand driven octrees
|
||||
mutable autoPtr<indexedOctree<treeDataFace> > boundaryTreePtr_;
|
||||
mutable autoPtr<indexedOctree<treeDataCell> > cellTreePtr_;
|
||||
|
||||
@ -97,20 +97,20 @@ class meshSearch
|
||||
|
||||
// Cells
|
||||
|
||||
//- nearest cell centre using octree
|
||||
//- Nearest cell centre using octree
|
||||
label findNearestCellTree(const point&) const;
|
||||
|
||||
//- nearest cell centre going through all cells
|
||||
//- Nearest cell centre going through all cells
|
||||
label findNearestCellLinear(const point&) const;
|
||||
|
||||
//- walk from seed. Does not 'go around' boundary, just returns
|
||||
//- Walk from seed. Does not 'go around' boundary, just returns
|
||||
// last cell before boundary.
|
||||
label findNearestCellWalk(const point&, const label) const;
|
||||
|
||||
//- cell containing location. Linear search.
|
||||
//- Cell containing location. Linear search.
|
||||
label findCellLinear(const point&) const;
|
||||
|
||||
//- walk from seed. Does not 'go around' boundary, just returns
|
||||
//- Walk from seed. Does not 'go around' boundary, just returns
|
||||
// last cell before boundary.
|
||||
label findCellWalk(const point&, const label) const;
|
||||
|
||||
@ -127,7 +127,7 @@ class meshSearch
|
||||
|
||||
// Boundary faces
|
||||
|
||||
//- walk from seed to find nearest boundary face. Gets stuck in
|
||||
//- Walk from seed to find nearest boundary face. Gets stuck in
|
||||
// local minimum.
|
||||
label findNearestBoundaryFaceWalk
|
||||
(
|
||||
@ -160,7 +160,7 @@ public:
|
||||
|
||||
// Static data members
|
||||
|
||||
//- tolerance on linear dimensions
|
||||
//- Tolerance on linear dimensions
|
||||
static scalar tol_;
|
||||
|
||||
|
||||
@ -271,7 +271,7 @@ public:
|
||||
bool isInside(const point&) const;
|
||||
|
||||
|
||||
//- delete all storage
|
||||
//- Delete all storage
|
||||
void clearOut();
|
||||
|
||||
//- Correct for mesh geom/topo changes
|
||||
|
||||
@ -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
|
||||
@ -63,10 +63,10 @@ private:
|
||||
//- 'right' point
|
||||
const point point2_;
|
||||
|
||||
//- length of vector point2-point1
|
||||
//- Length of vector point2-point1
|
||||
const scalar magDir_;
|
||||
|
||||
//- normalised vector point2-point1
|
||||
//- Normalised vector point2-point1
|
||||
const vector unitDir_;
|
||||
|
||||
//- Radius squared
|
||||
|
||||
@ -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
|
||||
@ -63,10 +63,10 @@ private:
|
||||
|
||||
// Per instance data
|
||||
|
||||
//- instance name
|
||||
//- Instance name
|
||||
wordList instance_;
|
||||
|
||||
//- scaling vector
|
||||
//- Scaling vector
|
||||
vectorField scale_;
|
||||
|
||||
//- transformation
|
||||
@ -76,7 +76,7 @@ private:
|
||||
|
||||
Switch mergeSubRegions_;
|
||||
|
||||
//- offsets for indices coming from different surfaces
|
||||
//- Offsets for indices coming from different surfaces
|
||||
// (sized with size() of each surface)
|
||||
labelList indexOffset_;
|
||||
|
||||
@ -136,25 +136,25 @@ public:
|
||||
|
||||
// Member Functions
|
||||
|
||||
//- scaling vector per subsurface
|
||||
//- Scaling vector per subsurface
|
||||
const vectorField& scale() const
|
||||
{
|
||||
return scale_;
|
||||
}
|
||||
|
||||
//- scaling vector per subsurface
|
||||
//- Scaling vector per subsurface
|
||||
vectorField& scale()
|
||||
{
|
||||
return scale_;
|
||||
}
|
||||
|
||||
//- coordinate system per subsurface
|
||||
//- Coordinate system per subsurface
|
||||
const PtrList<coordinateSystem>& transform() const
|
||||
{
|
||||
return transform_;
|
||||
}
|
||||
|
||||
//- coordinate system per subsurface
|
||||
//- Coordinate system per subsurface
|
||||
PtrList<coordinateSystem>& transform()
|
||||
{
|
||||
return transform_;
|
||||
|
||||
@ -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
|
||||
@ -65,7 +65,7 @@ private:
|
||||
|
||||
// Private Member Data
|
||||
|
||||
//- gap size in metre
|
||||
//- Gap size in metre
|
||||
const scalar gap_;
|
||||
|
||||
//- Underlying geometry (size 1)
|
||||
|
||||
@ -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
|
||||
@ -58,7 +58,7 @@ class boxToCell
|
||||
static addToUsageTable usage_;
|
||||
|
||||
|
||||
//- bounding box.
|
||||
//- Bounding box.
|
||||
treeBoundBoxList bbs_;
|
||||
|
||||
|
||||
|
||||
@ -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,10 +61,10 @@ class fieldToCell
|
||||
//- Name of volScalarField
|
||||
word fieldName_;
|
||||
|
||||
//- min to subset field values with
|
||||
//- Min to subset field values with
|
||||
scalar min_;
|
||||
|
||||
//- max ,,
|
||||
//- Max ,,
|
||||
scalar max_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -56,7 +56,7 @@ class labelToCell
|
||||
//- Add usage string
|
||||
static addToUsageTable usage_;
|
||||
|
||||
//- cell labels read from dictionary
|
||||
//- Cell labels read from dictionary
|
||||
labelList labels_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -56,7 +56,7 @@ class nearestToCell
|
||||
//- Add usage string
|
||||
static addToUsageTable usage_;
|
||||
|
||||
//- points to select nearest to
|
||||
//- Points to select nearest to
|
||||
pointField points_;
|
||||
|
||||
|
||||
|
||||
@ -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 @@ class rotatedBoxToCell
|
||||
static addToUsageTable usage_;
|
||||
|
||||
|
||||
//- skewed box
|
||||
//- Skewed box
|
||||
const vector origin_;
|
||||
const vector i_;
|
||||
const vector j_;
|
||||
|
||||
@ -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
|
||||
@ -76,7 +76,7 @@ public:
|
||||
|
||||
// Static data
|
||||
|
||||
//- cos of feature angle for polyHedral to be splitHex
|
||||
//- Cos of feature angle for polyHedral to be splitHex
|
||||
static scalar featureCos;
|
||||
|
||||
// Constructors
|
||||
|
||||
@ -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
|
||||
@ -87,21 +87,21 @@ class surfaceToCell
|
||||
// (does not allow includeCut)
|
||||
const bool useSurfaceOrientation_;
|
||||
|
||||
//- if > 0 : include cells with distance from cellCentre to surface
|
||||
//- If > 0 : include cells with distance from cellCentre to surface
|
||||
// less than nearDist.
|
||||
const scalar nearDist_;
|
||||
|
||||
//- if > -1 : include cells with normals at nearest surface points
|
||||
//- If > -1 : include cells with normals at nearest surface points
|
||||
// varying more than curvature_.
|
||||
const scalar curvature_;
|
||||
|
||||
//- triSurface to search on. On pointer since can be external.
|
||||
const triSurface* surfPtr_;
|
||||
|
||||
//- search engine on surface.
|
||||
//- Search engine on surface.
|
||||
const triSurfaceSearch* querySurfPtr_;
|
||||
|
||||
//- whether I allocated above surface ptrs or whether they are
|
||||
//- Whether I allocated above surface ptrs or whether they are
|
||||
// external.
|
||||
const bool IOwnPtrs_;
|
||||
|
||||
|
||||
@ -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
|
||||
@ -57,7 +57,7 @@ class boxToFace
|
||||
//- Add usage string
|
||||
static addToUsageTable usage_;
|
||||
|
||||
//- bounding box.
|
||||
//- Bounding box.
|
||||
treeBoundBoxList bbs_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -56,7 +56,7 @@ class labelToFace
|
||||
//- Add usage string
|
||||
static addToUsageTable usage_;
|
||||
|
||||
//- cell labels read from dictionary
|
||||
//- Cell labels read from dictionary
|
||||
labelList labels_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -57,7 +57,7 @@ class boxToPoint
|
||||
//- Add usage string
|
||||
static addToUsageTable usage_;
|
||||
|
||||
//- bounding box.
|
||||
//- Bounding box.
|
||||
treeBoundBoxList bbs_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -56,7 +56,7 @@ class labelToPoint
|
||||
//- Add usage string
|
||||
static addToUsageTable usage_;
|
||||
|
||||
//- point labels read from dictionary
|
||||
//- Point labels read from dictionary
|
||||
labelList labels_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -56,7 +56,7 @@ class nearestToPoint
|
||||
//- Add usage string
|
||||
static addToUsageTable usage_;
|
||||
|
||||
//- points to select nearest to
|
||||
//- Points to select nearest to
|
||||
pointField points_;
|
||||
|
||||
|
||||
|
||||
@ -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,13 +67,13 @@ class surfaceToPoint
|
||||
//- Name of surface file
|
||||
fileName surfName_;
|
||||
|
||||
//- if > 0 : include points with distance to surface less than nearDist.
|
||||
//- If > 0 : include points with distance to surface less than nearDist.
|
||||
scalar nearDist_;
|
||||
|
||||
//- include all points on opposite sign of normal on nearest surface.
|
||||
//- Include all points on opposite sign of normal on nearest surface.
|
||||
bool includeInside_;
|
||||
|
||||
//- include all points on this sign of normal on nearest surface.
|
||||
//- Include all points on this sign of normal on nearest surface.
|
||||
bool includeOutside_;
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -202,7 +202,7 @@ public:
|
||||
|
||||
// Member Functions
|
||||
|
||||
//- new to old face map. >0: surface 1 face label. <0: surface 2. Negate
|
||||
//- New to old face map. >0: surface 1 face label. <0: surface 2. Negate
|
||||
// and subtract 1 to get face label on surface 2.
|
||||
const labelList& faceMap() const
|
||||
{
|
||||
|
||||
@ -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
|
||||
@ -186,7 +186,7 @@ public:
|
||||
return faceEdges_;
|
||||
}
|
||||
|
||||
//- point to edge addressing
|
||||
//- Point to edge addressing
|
||||
const labelListList& pointEdges() const
|
||||
{
|
||||
return pointEdges_;
|
||||
|
||||
@ -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
|
||||
@ -138,7 +138,7 @@ public:
|
||||
|
||||
// Static data members
|
||||
|
||||
//- cosine between edge and face normal when considered parallel
|
||||
//- Cosine between edge and face normal when considered parallel
|
||||
// (note: should be private and make access- and set- function)
|
||||
static scalar alignedCos_;
|
||||
|
||||
|
||||
@ -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 @@ public:
|
||||
|
||||
private:
|
||||
|
||||
//- label and scalar; used in path walking
|
||||
//- Label and scalar; used in path walking
|
||||
class labelScalar
|
||||
{
|
||||
public:
|
||||
@ -242,13 +242,13 @@ public:
|
||||
return featureEdges_;
|
||||
}
|
||||
|
||||
//- start of external edges
|
||||
//- Start of external edges
|
||||
inline label externalStart() const
|
||||
{
|
||||
return externalStart_;
|
||||
}
|
||||
|
||||
//- start of internal edges
|
||||
//- Start of internal edges
|
||||
inline label internalStart() const
|
||||
{
|
||||
return internalStart_;
|
||||
|
||||
@ -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
|
||||
@ -110,7 +110,7 @@ class triSurfaceTools
|
||||
labelList& faceStatus
|
||||
);
|
||||
|
||||
//- faces to collapse because of edge collapse
|
||||
//- Faces to collapse because of edge collapse
|
||||
static labelHashSet getCollapsedFaces
|
||||
(
|
||||
const triSurface& surf,
|
||||
@ -433,7 +433,7 @@ public:
|
||||
const point& nearestPt
|
||||
);
|
||||
|
||||
//- on which side of surface
|
||||
//- On which side of surface
|
||||
enum sideType
|
||||
{
|
||||
UNKNOWN, // cannot be determined (e.g. non-manifold)
|
||||
@ -441,7 +441,7 @@ public:
|
||||
OUTSIDE // outside
|
||||
};
|
||||
|
||||
//- if nearest point is on edgeI, determine on which side of surface
|
||||
//- If nearest point is on edgeI, determine on which side of surface
|
||||
// sample is.
|
||||
static sideType edgeSide
|
||||
(
|
||||
|
||||
Reference in New Issue
Block a user