zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Doxygen documentation and files

Browse Source 
Contributed by Bruno Santos
Resolves patch report http://www.openfoam.org/mantisbt/view.php?id=2023

Update online documentation http://openfoam.github.io/Documentation-dev/html/
This commit is contained in:
Henry Weller
2016-03-14 11:00:24 +00:00
parent b4ebcd770f
commit e57874859a
52 changed files with 456 additions and 361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/meshTools/coordinateSystems/coordinateRotation/EulerCoordinateRotation.H
View File

@ -37,14 +37,17 @@ Description
- the rotation angles are in degrees, unless otherwise explictly specified:
\verbatim
coordinateRotation
{
type EulerRotation
degrees false;
rotation (0 0 3.141592654);
}
coordinateRotation
{
type EulerRotation;
degrees false;
rotation (0 0 3.141592654);
}
\endverbatim
SourceFiles
EulerCoordinateRotation.C
\*---------------------------------------------------------------------------*/
#ifndef EulerCoordinateRotation_H

15
src/meshTools/coordinateSystems/coordinateRotation/STARCDCoordinateRotation.H
View File

@ -34,14 +34,17 @@ Description
- the rotation angles are in degrees, unless otherwise explictly specified:
\verbatim
coordinateRotation
{
type STARCDRotation;
degrees false;
rotation (0 0 3.141592654);
}
coordinateRotation
{
type STARCDRotation;
degrees false;
rotation (0 0 3.141592654);
}
\endverbatim
SourceFiles
STARCDCoordinateRotation.C
\*---------------------------------------------------------------------------*/
#ifndef STARCDCoordinateRotation_H

18
src/meshTools/coordinateSystems/coordinateRotation/axesRotation.H
View File

@ -28,17 +28,21 @@ Description
A coordinate rotation specified using global axis
The rotation is defined by a combination of vectors (e1/e2), (e2/e3)
or (e3/e1). Any nonorthogonality will be absorbed into the second vector.
or (e3/e1). Any nonorthogonality will be absorbed into the second
vector.
\verbatim
axesRotation
{
type axesRotation;
e1 (1 0 0);
e2 (0 1 0);
}
axesRotation
{
type axesRotation;
e1 (1 0 0);
e2 (0 1 0);
}
\endverbatim
SourceFiles
axesRotation.C
\*---------------------------------------------------------------------------*/
#ifndef axesRotation_H

25
src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,21 +28,24 @@ Description
Abstract base class for coordinate rotation
\verbatim
coordinateRotation
{
type axesRotation
e1 (1 0 0);
e2 (0 1 0);
}
coordinateRotation
{
type axesRotation
e1 (1 0 0);
e2 (0 1 0);
}
\endverbatim
Types of coordinateRotation:
1) axesRotation
2) STARCDRotation
3) cylindrical
4) EulerCoordinateRotation
\li 1. axesRotation
\li 2. STARCDRotation
\li 3. cylindrical
\li 4. EulerCoordinateRotation
SourceFiles
coordinateRotation.C
coordinateRotationNew.C
\*---------------------------------------------------------------------------*/

22
src/meshTools/coordinateSystems/coordinateRotation/cylindrical.H
View File

@ -28,20 +28,22 @@ Description
A local coordinate rotation.
The cell based rotational field can be created in two ways:
1) Each rotational tensor is defined with two vectors (dir and e3)
where dir = cellC - origin and e3 is the rotation axis.
\li 1. Each rotational tensor is defined with two vectors (\c dir and \c e3)
where <tt>dir = cellC - origin</tt> and \c e3 is the rotation axis.
Per each cell an axesRotation type of rotation is created
(cylindrical coordinates)
(cylindrical coordinates). For example:
\verbatim
cylindrical
{
type localAxes;
e3 (0 0 1);
}
cylindrical
{
type localAxes;
e3 (0 0 1);
}
\endverbatim
2) The rotational tensor field is provided at construction
\li 2. The rotational tensor field is provided at construction.
SourceFiles
cylindrical.C
\*---------------------------------------------------------------------------*/

31
src/meshTools/coordinateSystems/coordinateSystem.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -30,30 +30,29 @@ Description
All systems are defined by an origin point and a co-ordinate rotation.
\verbatim
coordinateSystem
coordinateSystem
{
type cartesian;
origin (0 0 0);
coordinateRotation
{
type cartesian;
origin (0 0 0);
coordinateRotation
{
type cylindrical;
e3 (0 0 1);
}
type cylindrical;
e3 (0 0 1);
}
}
\endverbatim
Types of coordinateRotation:
1) axesRotation
2) STARCDRotation
3) cylindrical
4) EulerCoordinateRotation
\li 1. axesRotation
\li 2. STARCDRotation
\li 3. cylindrical
\li 4. EulerCoordinateRotation
Type of co-ordinates:
1) cartesian
\li 1. cartesian
See Also
coordinateSystem and coordinateSystem::New
SourceFiles
coordinateSystem.C

11
src/meshTools/mappedPatches/mappedPolyPatch/mappedPatchBase.H
View File

@ -29,6 +29,7 @@ Description
centres and processors they're on.
If constructed from dictionary:
\verbatim
// Region to sample (default is region0)
sampleRegion region0;
@ -63,8 +64,9 @@ Description
// According to offsetMode (see above) supply one of
// offset, offsets or distance
offset (1 0 0);
\endverbatim
Note: if offsetMode is 'normal' it uses outwards pointing normals. So
Note: if offsetMode is \c normal it uses outwards pointing normals. So
supply a negative distance if sampling inside the domain.
@ -218,9 +220,10 @@ protected:
// Derived information
//- Communication schedule:
// - Cells/faces to sample per processor
// - Patch faces to receive per processor
// - schedule
//
// - Cells/faces to sample per processor
// - Patch faces to receive per processor
// - schedule
mutable autoPtr<mapDistribute> mapPtr_;

13
src/meshTools/triSurface/surfaceLocation/surfaceLocation.H
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-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -26,16 +26,21 @@ Class
Description
Contains information about location on a triSurface:
- pointIndexHit:
\li pointIndexHit:
- location
- bool: hit/miss
- index (of triangle/point/edge)
- elementType():
\li elementType():
- what index above relates to. In triangle::proxType
- triangle():
\li triangle():
- last known triangle
SourceFiles
surfaceLocation.C
\*---------------------------------------------------------------------------*/