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

Documentation: converted javadoc @ to LaTeX style \ in Doxygen code docs

Browse Source
This commit is contained in:
Henry
2011-02-08 18:22:00 +00:00
parent 5339d687a4
commit c3cb632c24
221 changed files with 1096 additions and 8800 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/OSspecific/POSIX/regExp.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -29,7 +29,7 @@ Description
SeeAlso
The manpage regex(7) for more information about POSIX regular expressions.
These differ somewhat from @c Perl and @c sed regular expressions.
These differ somewhat from \c Perl and @c sed regular expressions.
SourceFiles
regExp.C

4
src/OSspecific/POSIX/signals/sigFpe.H
View File

@ -28,9 +28,9 @@ Description
Set up trapping for floating point exceptions (signal FPE).
Controlled by two env vars:
@param FOAM_SIGFPE \n
\param FOAM_SIGFPE \n
exception trapping
@param FOAM_SETNAN \n
\param FOAM_SETNAN \n
initialization of all malloced memory to NaN. If FOAM_SIGFPE
also set, this will cause usage of uninitialized scalars to trigger
an abort.

6
src/OSspecific/POSIX/timer.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,7 +28,7 @@ Description
Implements a timeout mechanism via sigalarm.
Example usage:
@code
\code
timer myTimer(5); // 5 sec
..
if (timedOut(myTimer))
@ -39,7 +39,7 @@ Description
{
// do something possible blocking
}
@endcode
\endcode
Constructor set signal handler on sigalarm and alarm(). Destructor
clears these.

6
src/OpenFOAM/containers/Lists/List/List.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -236,10 +236,10 @@ public:
//- Read a bracket-delimited list, or handle a single value as list of size 1.
// For example,
// @code
// \code
// wList = readList<word>(IStringStream("(patch1 patch2 patch3)")());
// wList = readList<word>(IStringStream("patch0")());
// @endcode
// \endcode
// Mostly useful for handling command-line arguments.
template<class T>
List<T> readList(Istream&);

6
src/OpenFOAM/containers/Lists/ListListOps/ListListOps.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -37,7 +37,7 @@ Description
in one go, minimizing communication, and then picked apart and recombined.
Example:
@code
\code
// Assuming myContainer defined which holds all the data I want to
// transfer (say a pointField and a faceList). myContainer also defines
// access operators to
@ -76,7 +76,7 @@ Description
gatheredData, sizes, myContainerFaces(), offsetOp<face>()
)
);
@endcode
\endcode
SourceFiles
ListListOps.C

4
src/OpenFOAM/containers/Lists/PackedList/PackedBoolList.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -54,7 +54,7 @@ namespace Foam
// Forward declaration
class PackedBoolList;
//- @typedef A List of PackedBoolList
//- \typedef A List of PackedBoolList
typedef List<PackedBoolList> PackedBoolListList;
/*---------------------------------------------------------------------------*\

30
src/OpenFOAM/containers/Lists/PackedList/PackedList.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -42,11 +42,11 @@ Note
Using the iteratorBase as a proxy allows assignment of values
between list elements. Thus the following bit of code works as expected:
@code
\code
list[1] = list[5]; // value assignment, not iterator position
list[2] = list[5] = 4; // propagates value
list[1] = list[5] = list[6]; // propagates value
@endcode
\endcode
Using get() or the '[]' operator are similarly fast. Looping and reading
via an iterator is approx. 15% slower, but can be more flexible.
@ -56,21 +56,21 @@ Note
advantage of also returning a bool if the value changed. This can be
useful for branching on changed values.
@code
\code
list[5] = 4;
changed = list.set(5, 8);
if (changed) ...
@endcode
\endcode
The lazy evaluation used means that reading an out-of-range element
returns zero, but does not affect the list size. Even in a non-const
context, only the assigment itself causes the element to be created.
For example,
@code
\code
list.resize(4);
Info<< list[10] << "\n"; // print zero, but doesn't adjust list
list[8] = 1;
@endcode
\endcode
Also note that all unused internal storage elements are guaranteed to
always be bit-wise zero. This property must not be violated by any
@ -79,14 +79,14 @@ Note
In addition to the normal output format, PackedList also supports a
compact ASCII format that may be convenient for user input in some
situations. The general format is a group of index/value pairs:
@verbatim
\verbatim
{ (index1 value1) (index2 value2) (index3 value3) }
@endverbatim
\endverbatim
The bool specialization just uses the indices corresponding to
non-zero entries instead of a index/value pair:
@verbatim
\verbatim
{ index1 index2 index3 }
@endverbatim
\endverbatim
In both cases, the supplied indices can be randomly ordered.
SeeAlso
@ -356,14 +356,14 @@ public:
//
// The indexed output may be convenient in some situations.
// The general format is a group of index/value pairs:
// @verbatim
// \verbatim
// { (index1 value1) (index2 value2) (index3 value3) }
// @endverbatim
// \endverbatim
// The bool specialization just uses the indices corresponding to
// non-zero entries instead of a index/value pair:
// @verbatim
// \verbatim
// { index1 index2 index3 }
// @endverbatim
// \endverbatim
//
// Note the indexed output is only supported for ASCII streams.
Ostream& write

54
src/OpenFOAM/containers/Lists/UList/UList.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -367,28 +367,28 @@ inline void reverse(UList<T>&);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
/**
* @def forAll(list, i)
* Loop across all elements in @a list
* @par Usage
* @code
* \def forAll(list, i)
* Loop across all elements in \a list
* \par Usage
* \code
* forAll(anyList, i)
* {
* statements;
* }
* @endcode
* @sa forAllReverse
* \endcode
* \sa forAllReverse
*/
/**
* @def forAllReverse(list, i)
* Reverse loop across all elements in @a list
* @par Usage
* @code
* \def forAllReverse(list, i)
* Reverse loop across all elements in \a list
* \par Usage
* \code
* forAllReverse(anyList, i)
* {
* statements;
* }
* @endcode
* @sa forAll
* \endcode
* \sa forAll
*/
#define forAll(list, i) \
for (Foam::label i=0; i<(list).size(); i++)
@ -397,17 +397,17 @@ inline void reverse(UList<T>&);
for (Foam::label i=(list).size()-1; i>=0; i--)
/**
* @def forAllIter(Container, container, iter)
* Iterate across all elements in the @a container object of type
* @a Container.
* @par Usage
* @code
* \def forAllIter(Container, container, iter)
* Iterate across all elements in the \a container object of type
* \a Container.
* \par Usage
* \code
* forAll(ContainerType, container, iter)
* {
* statements;
* }
* @endcode
* @sa forAllConstIter
* \endcode
* \sa forAllConstIter
*/
#define forAllIter(Container,container,iter) \
for \
@ -418,17 +418,17 @@ inline void reverse(UList<T>&);
)
/**
* @def forAllConstIter(Container, container, iter)
* Iterate across all elements in the @a container object of type
* @a Container with const access.
* @par Usage
* @code
* \def forAllConstIter(Container, container, iter)
* Iterate across all elements in the \a container object of type
* \a Container with const access.
* \par Usage
* \code
* forAllConstIter(ContainerType, container, iter)
* {
* statements;
* }
* @endcode
* @sa forAllIter
* \endcode
* \sa forAllIter
*/
#define forAllConstIter(Container,container,iter) \
for \

18
src/OpenFOAM/db/IOobject/IOobject.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -33,32 +33,32 @@ Description
path, a reference to a objectRegistry, and parameters determining its
storage status.
@par Read options
\par Read options
Define what is done on object construction and explicit reads:
@param MUST_READ
\param MUST_READ
Object must be read from Istream on construction. \n
Error if Istream does not exist or can't be read.
Does not check timestamp or re-read.
@param MUST_READ_IF_MODIFIED
\param MUST_READ_IF_MODIFIED
Object must be read from Istream on construction. \n
Error if Istream does not exist or can't be read. If object is
registered its timestamp will be checked every timestep and possibly
re-read.
@param READ_IF_PRESENT
\param READ_IF_PRESENT
Read object from Istream if Istream exists, otherwise don't. \n
Error only if Istream exists but can't be read.
Does not check timestamp or re-read.
@param NO_READ
\param NO_READ
Don't read
@par Write options
\par Write options
Define what is done on object destruction and explicit writes:
@param AUTO_WRITE
\param AUTO_WRITE
Object is written automatically when requested to by the
objectRegistry.
@param NO_WRITE
\param NO_WRITE
No automatic write on destruction but can be written explicitly
SourceFiles

18
src/OpenFOAM/db/Time/Time.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -393,39 +393,39 @@ public:
//- Return true if run should continue,
// also invokes the functionObjectList::end() method
// when the time goes out of range
// @note
// \note
// For correct behaviour, the following style of time-loop
// is recommended:
// @code
// \code
// while (runTime.run())
// {
// runTime++;
// solve;
// runTime.write();
// }
// @endcode
// \endcode
virtual bool run() const;
//- Return true if run should continue and if so increment time
// also invokes the functionObjectList::end() method
// when the time goes out of range
// @note
// \note
// For correct behaviour, the following style of time-loop
// is recommended:
// @code
// \code
// while (runTime.loop())
// {
// solve;
// runTime.write();
// }
// @endcode
// \endcode
virtual bool loop();
//- Return true if end of run,
// does not invoke any functionObject methods
// @note
// \note
// The rounding heuristics near endTime mean that
// @code run() @endcode and @code !end() @endcode may
// \code run() \endcode and \code !end() \endcode may
// not yield the same result
virtual bool end() const;

46
src/OpenFOAM/db/Time/timeSelector.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -30,7 +30,7 @@ Description
The timeSelector provides a convenient means of selecting multiple
times. A typical use would be the following:
@verbatim
\verbatim
timeSelector::addOptions();
// add other options
#include "setRootCase.H"
@ -41,27 +41,27 @@ Description
{
...
}
@endverbatim
\endverbatim
The result program would receive @b -time, @b -latestTime, @b -constant
and @b -noZero options. The @b -constant option explicitly includes the
@c constant/ directory in the time list and the @b -noZero option
explicitly excludes the @c 0/ directory from the time list.
The result program would receive \b -time, @b -latestTime, @b -constant
and \b -noZero options. The @b -constant option explicitly includes the
\c constant/ directory in the time list and the \b -noZero option
explicitly excludes the \c 0/ directory from the time list.
There may however also be many cases in which neither the @c constant/
directory nor the @c 0/ directory contain particularly relevant
There may however also be many cases in which neither the \c constant/
directory nor the \c 0/ directory contain particularly relevant
information. This might occur, for example, when post-processing
results. In this case, addOptions is called with optional boolean
arguments.
@verbatim
\verbatim
timeSelector::addOptions(false, true);
@endverbatim
\endverbatim
The first argument avoids adding the @b -constant option. The second
argument adds an additional @b -zeroTime option and also prevents the
@c 0/ directory from being included in the default time range and in the
@b -latestTime selection.
The first argument avoids adding the \b -constant option. The second
argument adds an additional \b -zeroTime option and also prevents the
\c 0/ directory from being included in the default time range and in the
\b -latestTime selection.
SourceFiles
timeSelector.C
@ -119,15 +119,15 @@ public:
//- Add the options handled by timeSelector to argList::validOptions
//
// @param constant
// Add the @b -constant option to include the @c constant/ directory
// \param constant
// Add the \b -constant option to include the \c constant/ directory
//
// @param zeroTime
// Enable the @b -zeroTime option and alter the normal time selection
// behaviour (and @b -latestTime behaviour) to exclude the @c 0/
// directory. The @c 0/ directory will only be included when
// @b -zeroTime is specified.
// The @b -noZero option has precedence over the @b -zeroTime option.
// \param zeroTime
// Enable the \b -zeroTime option and alter the normal time selection
// behaviour (and \b -latestTime behaviour) to exclude the \c 0/
// directory. The \c 0/ directory will only be included when
// \b -zeroTime is specified.
// The \b -noZero option has precedence over the @b -zeroTime option.
static void addOptions
(
const bool constant=true,

4
src/OpenFOAM/db/dictionary/functionEntries/functionEntry/functionEntry.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -35,7 +35,7 @@ Description
A functionEntry causes entries to be added/manipulated on the specified
dictionary given an input stream.
In dictionaries, a @c '\#' sigil is typically used for a functionEntry.
In dictionaries, a \c '\#' sigil is typically used for a functionEntry.
SourceFiles
functionEntry.C

10
src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,13 +28,13 @@ Description
Specify an include file when reading dictionaries, expects a
single string to follow.
An example of the @c \#include directive:
@verbatim
An example of the \c \#include directive:
\verbatim
#include "includeFile"
@endverbatim
\endverbatim
The usual expansion of environment variables and other constructs
(eg, the @c ~OpenFOAM/ expansion) is retained.
(eg, the \c ~OpenFOAM/ expansion) is retained.
See Also
fileName, string::expand()

4
src/OpenFOAM/db/dictionary/functionEntries/includeIfPresentEntry/includeIfPresentEntry.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -27,7 +27,7 @@ Class
Description
Specify a file to include if it exists. Expects a single string to follow.
The @c \#includeIfPresent directive is similar to the @c \#include
The \c \#includeIfPresent directive is similar to the @c \#include
directive, but does not generate an error if the file does not exist.
See Also

20
src/OpenFOAM/db/dictionary/functionEntries/inputModeEntry/inputModeEntry.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,18 +28,18 @@ Description
Specify the input mode when reading dictionaries, expects
a single word to follow.
An example of @c \#inputMode directive:
@verbatim
An example of \c \#inputMode directive:
\verbatim
#inputMode merge
@endverbatim
\endverbatim
The possible input modes:
@param merge merge sub-dictionaries when possible
@param overwrite keep last entry and silently remove previous ones
@param protect keep initial entry and silently ignore subsequent ones
@param warn keep initial entry and warn about subsequent ones
@param error issue a FatalError for duplicate entries
@param default currently identical to merge
\param merge merge sub-dictionaries when possible
\param overwrite keep last entry and silently remove previous ones
\param protect keep initial entry and silently ignore subsequent ones
\param warn keep initial entry and warn about subsequent ones
\param error issue a FatalError for duplicate entries
\param default currently identical to merge
SourceFiles
inputModeEntry.C

8
src/OpenFOAM/db/dictionary/functionEntries/removeEntry/removeEntry.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -27,14 +27,14 @@ Class
Description
Remove a dictionary entry.
The @c \#remove directive takes a list or a single wordRe.
The \c \#remove directive takes a list or a single wordRe.
For example,
@verbatim
\verbatim
#remove entry0
#remove ( entry1 entry2 entry3 otherEntry )
#remove "entry[1-3]"
#remove ( "entry[1-3]" otherEntry )
@endverbatim
\endverbatim
The removal only occurs in the current context.
Removing sub-entries or parent entries is not supported.

4
src/OpenFOAM/db/error/StaticAssert.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -72,7 +72,7 @@ class StaticAssertionTest {};
// external use:
// ~~~~~~~~~~~~~
/**
* @def StaticAssert(Test)
* \def StaticAssert(Test)
* Assert that some test is true at compile-time
*/
#define StaticAssert(Test) \

14
src/OpenFOAM/db/error/error.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -35,10 +35,10 @@ Description
handling has beed switched on (off by default).
Usage
@code
\code
error << "message1" << "message2" << FoamDataType << exit(errNo);
error << "message1" << "message2" << FoamDataType << abort();
@endcode
\endcode
SourceFiles
error.C
@ -296,7 +296,7 @@ extern IOerror FatalIOError;
// Convenience macros to add the file name and line number to the function name
/**
* @def FatalErrorIn(functionName)
* \def FatalErrorIn(functionName)
* Report an error message using Foam::FatalError for functionName in
* file __FILE__ at line __LINE__
*/
@ -304,7 +304,7 @@ extern IOerror FatalIOError;
::Foam::FatalError((fn), __FILE__, __LINE__)
/**
* @def FatalIOErrorIn(functionName, ios)
* \def FatalIOErrorIn(functionName, ios)
* Report an error message using Foam::FatalIOError for functionName in
* file __FILE__ at line __LINE__
* for a particular IOstream
@ -313,12 +313,12 @@ extern IOerror FatalIOError;
::Foam::FatalIOError((fn), __FILE__, __LINE__, (ios))
/**
* @def notImplemented(functionName)
* \def notImplemented(functionName)
* Issue a FatalErrorIn for the functionName.
* This is used for functions that are not currently implemented.
* The functionName is printed and then abort is called.
*
* @note
* \note
* This macro can be particularly useful when methods must be defined to
* complete the interface of a derived class even if they should never be
* called for this derived class.

6
src/OpenFOAM/db/error/errorManip.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -30,10 +30,10 @@ Description
handling has been switched on (off by default).
Usage
@code
\code
error << "message1" << "message2" << FoamDataType << exit(error, errNo);
error << "message1" << "message2" << FoamDataType << abort(error);
@endcode
\endcode
\*---------------------------------------------------------------------------*/

18
src/OpenFOAM/db/error/messageStream.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -34,10 +34,10 @@ Description
the messageStream class in the standard manner.
Usage
@code
\code
messageStream
<< "message1" << "message2" << FoamDataType << endl;
@endcode
\endcode
SourceFiles
messageStream.C
@ -214,7 +214,7 @@ extern messageStream Info;
// Convenience macros to add the file name and line number to the function name
/**
* @def SeriousErrorIn(functionName)
* \def SeriousErrorIn(functionName)
* Report an error message using Foam::SeriousError for functionName in
* file __FILE__ at line __LINE__
*/
@ -222,7 +222,7 @@ extern messageStream Info;
::Foam::SeriousError((fn), __FILE__, __LINE__)
/**
* @def SeriousIOErrorIn(functionName, ios)
* \def SeriousIOErrorIn(functionName, ios)
* Report an IO error message using Foam::SeriousError for functionName in
* file __FILE__ at line __LINE__
* for a particular IOstream
@ -231,7 +231,7 @@ extern messageStream Info;
::Foam::SeriousError((fn), __FILE__, __LINE__, ios)
/**
* @def WarningIn(functionName)
* \def WarningIn(functionName)
* Report a warning using Foam::Warning for functionName in
* file __FILE__ at line __LINE__
*/
@ -239,7 +239,7 @@ extern messageStream Info;
::Foam::Warning((fn), __FILE__, __LINE__)
/**
* @def IOWarningIn(functionName, ios)
* \def IOWarningIn(functionName, ios)
* Report an IO warning using Foam::Warning for functionName in
* file __FILE__ at line __LINE__
* for a particular IOstream
@ -248,7 +248,7 @@ extern messageStream Info;
::Foam::Warning((fn), __FILE__, __LINE__, (ios))
/**
* @def InfoIn(functionName)
* \def InfoIn(functionName)
* Report a information message using Foam::Info for functionName in
* file __FILE__ at line __LINE__
*/
@ -256,7 +256,7 @@ extern messageStream Info;
::Foam::Info((fn), __FILE__, __LINE__)
/**
* @def IOInfoIn(functionName, ios)
* \def IOInfoIn(functionName, ios)
* Report an IO information message using Foam::Info for functionName in
* file __FILE__ at line __LINE__
* for a particular IOstream

6
src/OpenFOAM/db/functionObjects/OutputFilterFunctionObject/OutputFilterFunctionObject.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -30,9 +30,9 @@ Description
Note
Since the timeIndex is used directly from Foam::Time, it is unaffected
by user-time conversions. For example, Foam::engineTime might cause @a
by user-time conversions. For example, Foam::engineTime might cause \a
writeInterval to be degrees crank angle, but the functionObject
execution @a interval would still be in timestep.
execution \a interval would still be in timestep.
SourceFiles
OutputFilterFunctionObject.C

4
src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -108,7 +108,7 @@ public:
//- Construct from Time, a dictionary with "functions" entry
// and the execution setting.
// @param[in] parentDict - the parent dictionary containing
// \param[in] parentDict - the parent dictionary containing
// a "functions" entry, which can either be a list or a dictionary
// of functionObject specifications.
functionObjectList

4
src/OpenFOAM/db/functionObjects/outputFilterOutputControl/outputFilterOutputControl.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -74,7 +74,7 @@ private:
//- Type of output
outputControls outputControl_;
//- The execution interval (in time steps) when using @c timeStep mode,
//- The execution interval (in time steps) when using \c timeStep mode,
// a value <= 1 means execute at every time step
label outputInterval_;

38
src/OpenFOAM/db/typeInfo/className.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -39,19 +39,19 @@ Description
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//- Add typeName information from argument @a TypeNameString to a class.
//- Add typeName information from argument \a TypeNameString to a class.
// Without debug information
#define ClassNameNoDebug(TypeNameString) \
static const char* typeName_() { return TypeNameString; } \
static const ::Foam::word typeName
//- Add typeName information from argument @a TypeNameString to a namespace.
//- Add typeName information from argument \a TypeNameString to a namespace.
// Without debug information.
#define NamespaceNameNoDebug(TypeNameString) \
inline const char* typeName_() { return TypeNameString; } \
extern const ::Foam::word typeName
//- Add typeName information from argument @a TemplateNameString to a
//- Add typeName information from argument \a TemplateNameString to a
// template class. Without debug information.
#define TemplateNameNoDebug(TemplateNameString) \
class TemplateNameString##Name \
@ -68,19 +68,19 @@ public: \
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//- Add typeName information from argument @a TypeNameString to a class.
//- Add typeName information from argument \a TypeNameString to a class.
// Also declares debug information.
#define ClassName(TypeNameString) \
ClassNameNoDebug(TypeNameString); \
static int debug
//- Add typeName information from argument @a TypeNameString to a namespace.
//- Add typeName information from argument \a TypeNameString to a namespace.
// Also declares debug information.
#define NamespaceName(TypeNameString) \
NamespaceNameNoDebug(TypeNameString); \
extern int debug
//- Add typeName information from argument @a TypeNameString to a
//- Add typeName information from argument \a TypeNameString to a
// template class. Also declares debug information.
#define TemplateName(TemplateNameString) \
class TemplateNameString##Name \
@ -97,7 +97,7 @@ public: \
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//- Define the typeName, with alternative lookup as @a Name
//- Define the typeName, with alternative lookup as \a Name
#define defineTypeNameWithName(Type, Name) \
const ::Foam::word Type::typeName(Name)
@ -106,18 +106,18 @@ public: \
defineTypeNameWithName(Type, Type::typeName_())
#ifdef __INTEL_COMPILER
//- Define the typeName as @a Name for template classes
//- Define the typeName as \a Name for template classes
# define defineTemplateTypeNameWithName(Type, Name) \
defineTypeNameWithName(Type, Name)
//- Define the typeName as @a Name for template sub-classes
//- Define the typeName as \a Name for template sub-classes
# define defineTemplate2TypeNameWithName(Type, Name) \
defineTypeNameWithName(Type, Name)
#else
//- Define the typeName as @a Name for template classes
//- Define the typeName as \a Name for template classes
# define defineTemplateTypeNameWithName(Type, Name) \
template<> \
defineTypeNameWithName(Type, Name)
//- Define the typeName as @a Name for template sub-classes
//- Define the typeName as \a Name for template sub-classes
# define defineTemplate2TypeNameWithName(Type, Name) \
template<> \
template<> \
@ -139,7 +139,7 @@ public: \
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//- Define the debug information, lookup as @a Name
//- Define the debug information, lookup as \a Name
#define defineDebugSwitchWithName(Type, Name, DebugSwitch) \
int Type::debug(::Foam::debug::debugSwitch(Name, DebugSwitch))
@ -148,18 +148,18 @@ public: \
defineDebugSwitchWithName(Type, Type::typeName_(), DebugSwitch)
#ifdef __INTEL_COMPILER
//- Define the debug information for templates, lookup as @a Name
//- Define the debug information for templates, lookup as \a Name
# define defineTemplateDebugSwitchWithName(Type, Name, DebugSwitch) \
defineDebugSwitchWithName(Type, Name, DebugSwitch)
//- Define the debug information for templates sub-classes, lookup as @a Name
//- Define the debug information for templates sub-classes, lookup as \a Name
# define defineTemplate2DebugSwitchWithName(Type, Name, DebugSwitch) \
defineDebugSwitchWithName(Type, Name, DebugSwitch)
#else
//- Define the debug information for templates, lookup as @a Name
//- Define the debug information for templates, lookup as \a Name
# define defineTemplateDebugSwitchWithName(Type, Name, DebugSwitch) \
template<> \
defineDebugSwitchWithName(Type, Name, DebugSwitch)
//- Define the debug information for templates sub-classes, lookup as @a Name
//- Define the debug information for templates sub-classes, lookup as \a Name
# define defineTemplate2DebugSwitchWithName(Type, Name, DebugSwitch) \
template<> \
template<> \
@ -199,7 +199,7 @@ public: \
defineTypeName(Type); \
defineDebugSwitch(Type, DebugSwitch)
//- Define the typeName and debug information, lookup as @a Name
//- Define the typeName and debug information, lookup as \a Name
#define defineTemplateTypeNameAndDebugWithName(Type, Name, DebugSwitch) \
defineTemplateTypeNameWithName(Type, Name); \
defineTemplateDebugSwitchWithName(Type, Name, DebugSwitch)
@ -216,7 +216,7 @@ public: \
// for templated sub-classes
//- Define the typeName and debug information, lookup as @a Name
//- Define the typeName and debug information, lookup as \a Name
#define defineTemplate2TypeNameAndDebugWithName(Type, Name, DebugSwitch) \
defineTemplate2TypeNameWithName(Type, Name); \
defineTemplate2DebugSwitchWithName(Type, Name, DebugSwitch)

14
src/OpenFOAM/db/typeInfo/typeInfo.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -29,22 +29,22 @@ Description
Used to enhance the standard RTTI to cover I/O.
The user can get the type's type name using the type info access function
@code
\code
type()
@endcode
\endcode
The reference type cast template function:
@code
\code
refCast<T>(r)
@endcode
\endcode
wraps dynamic_cast to handle the bad_cast exception and generate a
FatalError.
The isA function:
@code
\code
isA<T>(r)
@endcode
\endcode
returns true if r is of type T or derived from type T.

36
src/OpenFOAM/global/argList/argList.H
View File

@ -26,38 +26,38 @@ Class
Description
Extract command arguments and options from the supplied
@a argc and @a argv parameters.
\a argc and @a argv parameters.
Sequences with "(" ... ")" are transformed into a stringList.
For example,
@verbatim
\verbatim
program -listFiles \( *.txt \)
@endverbatim
\endverbatim
would create a stringList:
@verbatim
\verbatim
( "file1.txt" "file2.txt" ... "fileN.txt" )
@endverbatim
\endverbatim
The backslash-escaping is required to avoid interpretation by the shell.
@par Default command-line options
@param -case \<dir\> \n
\par Default command-line options
\param -case \<dir\> \n
select an case directory instead of the current working directory
@param -parallel \n
\param -parallel \n
specify case as a parallel job
@param -doc \n
\param -doc \n
display the documentation in browser
@param -srcDoc \n
\param -srcDoc \n
display the source documentation in browser
@param -help \n
\param -help \n
print the usage
The environment variable @b FOAM_CASE is set to the path of the
The environment variable \b FOAM_CASE is set to the path of the
global case (same for serial and parallel jobs).
The environment variable @b FOAM_CASENAME is set to the name of the
The environment variable \b FOAM_CASENAME is set to the name of the
global case.
Note
- The document browser used is defined by the @b FOAM_DOC_BROWSER
- The document browser used is defined by the \b FOAM_DOC_BROWSER
environment variable or the <tt>Documentation/docBrowser</tt> entry
in the <tt>~OpenFOAM/controlDict</tt> file.
The \%f token is used as a placeholder for the file name.
@ -168,14 +168,14 @@ public:
//- Max screen width for displaying usage (default: 80)
static string::size_type usageMax;
//! @cond internalClass
//! \cond internalClass
class initValidTables
{
public:
initValidTables();
};
//! @endcond
//! \endcond
// Constructors
@ -230,7 +230,7 @@ public:
inline T argRead(const label index) const;
//- Return arguments that are additional to the executable
// @deprecated use operator[] directly (deprecated Feb 2010)
// \deprecated use operator[] directly (deprecated Feb 2010)
stringList::subList additionalArgs() const
{
return stringList::subList(args_, args_.size()-1, 1);
@ -292,7 +292,7 @@ public:
inline const string& operator[](const label index) const;
//- Return the argument string associated with the named option
// @sa option()
// \sa option()
inline const string& operator[](const word& opt) const;
// Edit

6
src/OpenFOAM/global/debug/debug.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -38,7 +38,7 @@ namespace Foam
namespace debug
{
//! @cond ignoreDocumentation - local scope
//! \cond ignoreDocumentation - local scope
dictionary* controlDictPtr_(NULL);
dictionary* debugSwitchesPtr_(NULL);
dictionary* infoSwitchesPtr_(NULL);
@ -63,7 +63,7 @@ public:
};
deleteControlDictPtr deleteControlDictPtr_;
//! @endcond
//! \endcond
} // End namespace debug

4
src/OpenFOAM/global/debug/debug.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -49,7 +49,7 @@ namespace debug
{
//- The central control dictionary.
// Located in ~/.OpenFOAM/VERSION or $WM_PROJECT_DIR/etc
// @sa Foam::findEtcFile()
// \sa Foam::findEtcFile()
dictionary& controlDict();
//- The DebugSwitches sub-dictionary in the central controlDict.

4
src/OpenFOAM/graph/writers/xmgrGraph/xmgrGraph.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -25,7 +25,7 @@ Class
Foam::xmgrGraph
Description
Output and @b agr file for @em xmgrace
Output and \b agr file for \em xmgrace
(http://plasma-gate.weizmann.ac.il/Grace/)
SourceFiles

4
src/OpenFOAM/include/OSspecific.H
View File

@ -90,7 +90,7 @@ fileName cwd();
// else return false
bool chDir(const fileName& dir);
//- Search for @em name
//- Search for \em name
// in the following hierarchy:
// -# personal settings:
// - ~/.OpenFOAM/\<VERSION\>/
@ -105,7 +105,7 @@ bool chDir(const fileName& dir);
// -# shipped settings:
// - $WM_PROJECT_DIR/etc/
//
// @return the full path name or fileName() if the name cannot be found
// \return the full path name or fileName() if the name cannot be found
// Optionally abort if the file cannot be found
fileName findEtcFile(const fileName&, bool mandatory=false);

4
src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H
View File

@ -29,9 +29,9 @@ Description
The reference scalar values must be monotonically increasing.
The handling of out-of-bounds values depends on the current setting
of @a outOfBounds.
of \a outOfBounds.
If @a REPEAT is chosen for the out-of-bounds handling, the final time
If \a REPEAT is chosen for the out-of-bounds handling, the final time
value is treated as being equivalent to time=0 for the following periods.
Note

6
src/OpenFOAM/interpolations/uniformInterpolationTable/uniformInterpolationTable.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2009-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -30,7 +30,7 @@ Description
Example usage (scalar): values specified within a dictionary:
@verbatim
\verbatim
{
x0 0; // lower limit
dx 0.2; // fixed interval
@ -43,7 +43,7 @@ Description
7870 // value at x0 + n*dx
);
}
@endverbatim
\endverbatim
SourceFiles
uniformInterpolationTable.C

10
src/OpenFOAM/matrices/lduMatrix/lduAddressing/lduAddressing.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -38,7 +38,7 @@ Description
the same point. The neighbour labels are also ordered in ascending
order but only for groups of edges belonging to each point. An example
is given below:
@verbatim
\verbatim
owner eighbour
0 1
0 20
@ -60,7 +60,7 @@ Description
8 28
9 10
9 29
@endverbatim
\endverbatim
There exists an alternative way of addressing the owner
list: instead of repeating the same label in the owner list, it is
@ -68,9 +68,9 @@ Description
neighbour list. This reduces the size of owner addressing from a list
over all edges to a list over all points + 1:
@verbatim
\verbatim
Owner start list: 0 2 4 6 8 10 12 14 16 18
@endverbatim
\endverbatim
We shall use the second form of the addressing for fast lookup
of edge label from the known owner and neighbour, using the following

6
src/OpenFOAM/matrices/solution/solution.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -36,12 +36,12 @@ License
int Foam::solution::debug(::Foam::debug::debugSwitch("solution", 0));
// List of sub-dictionaries to rewrite
//! @cond localScope
//! \cond localScope
static const Foam::List<Foam::word> subDictNames
(
Foam::IStringStream("(preconditioner smoother)")()
);
//! @endcond
//! \endcond
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //

36
src/OpenFOAM/memory/Xfer/Xfer.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -43,21 +43,21 @@ Description
memory becoming inaccessible, the xferMoveTo() function should be used to
invoke the correct List\<T\>::transfer(DynamicList\<T\>&) method.
@code
\code
DynamicList<label> dynLst;
...
labelList plainLst( xferMoveTo<labelList>(dynLst) );
@endcode
\endcode
Of course, since this example is a very common operation, the
DynamicList::xfer() method transfers to a plain List anyhow.
It would thus be simpler (and clearer) just to use the following code:
@code
\code
DynamicList<label> dynLst;
...
labelList plainLst(dynLst.xfer());
@endcode
\endcode
SeeAlso
xferCopy, xferCopyTo, xferMove, xferMoveTo, xferTmp
@ -135,53 +135,53 @@ public:
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
/**
* Construct by copying the contents of the @a arg
* Construct by copying the contents of the \a arg
*
* @sa xferCopyTo, xferMove, xferMoveTo, xferTmp and Foam::Xfer
* \sa xferCopyTo, xferMove, xferMoveTo, xferTmp and Foam::Xfer
*/
template<class T>
inline Xfer<T> xferCopy(const T&);
/**
* Construct by transferring the contents of the @a arg
* Construct by transferring the contents of the \a arg
*
* @sa xferCopy, xferCopyTo, xferMoveTo, xferTmp and Foam::Xfer
* \sa xferCopy, xferCopyTo, xferMoveTo, xferTmp and Foam::Xfer
*/
template<class T>
inline Xfer<T> xferMove(T&);
/**
* Construct by transferring the contents of the @a arg
* Construct by transferring the contents of the \a arg
*
* @sa xferCopy, xferCopyTo, xferMove, xferMoveTo and Foam::Xfer
* \sa xferCopy, xferCopyTo, xferMove, xferMoveTo and Foam::Xfer
*/
template<class T>
inline Xfer<T> xferTmp(Foam::tmp<T>&);
/**
* Construct by copying the contents of the @a arg
* Construct by copying the contents of the \a arg
* between dissimilar types
*
* @sa xferCopy, xferMove, xferMoveTo, xferTmp and Foam::Xfer
* \sa xferCopy, xferMove, xferMoveTo, xferTmp and Foam::Xfer
*/
template<class To, class From>
inline Xfer<To> xferCopyTo(const From&);
/**
* Construct by transferring the contents of the @a arg
* Construct by transferring the contents of the \a arg
* between dissimilar types
*
* @par Example Use
* @code
* \par Example Use
* \code
* DynamicList<label> dynLst;
* ...
* labelList plainLst( xferMoveTo<labelList>(dynLst) );
* @endcode
* \endcode
*
* @sa xferCopy, xferCopyTo, xferMove, xferTmp and Foam::Xfer
* \sa xferCopy, xferCopyTo, xferMove, xferTmp and Foam::Xfer
*/
template<class To, class From>
inline Xfer<To> xferMoveTo(From&);

16
src/OpenFOAM/meshes/meshShapes/cellMatcher/cellMatcher.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -31,22 +31,22 @@ Description
cell-face to mesh-face mapping.
For example,
@verbatim
\verbatim
hexMatcher hex(mesh);
cellShape shape;
..
bool isHex = hex.match(cellI, shape);
@endverbatim
Now shape is set to the correct Hex cellShape (if @a isHex is true)
\endverbatim
Now shape is set to the correct Hex cellShape (if \a isHex is true)
Alternatively there is direct access to the vertex and face mapping:
@verbatim
\verbatim
const labelList& hexVertLabels = hex.vertLabels();
const labelList& hexFaceLabels = hex.faceLabels();
@endverbatim
\endverbatim
Now
- @c hexVertLabels[n] is vertex label of hex vertex n
- @c hexFaceLabels[n] is face label of hex vertex n
- \c hexVertLabels[n] is vertex label of hex vertex n
- \c hexFaceLabels[n] is face label of hex vertex n
Process of cellShape recognition consists of following steps:
- renumber vertices of cell to local vertex numbers

4
src/OpenFOAM/meshes/polyMesh/globalMeshData/globalPoints.H
View File

@ -41,9 +41,9 @@ Description
Works by constructing equivalence lists for all the points on processor
patches. These list are in globalIndexAndTransform numbering
E.g.
@verbatim
\verbatim
((7 93)(4 731)(3 114))
@endverbatim
\endverbatim
means point 93 on proc7 is connected to point 731 on proc4 and 114 on proc3.
It then assigns the lowest numbered processor to be the local 'master' and

8
src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapPolyMesh.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -49,7 +49,7 @@ Description
All this information is nessecary to correctly map fields.
@par points
\par points
- unchanged:
- pointMap[pointI] contains old point label
@ -66,7 +66,7 @@ Description
- appended:
- pointMap[pointI] contains -1
@par faces
\par faces
- unchanged:
- faceMap[faceI] contains old face label
@ -98,7 +98,7 @@ Description
only be boundary faces; if the new face is an internal face they
will only be internal faces.
@par cells
\par cells
- unchanged:
- cellMap[cellI] contains old cell label

8
src/OpenFOAM/meshes/primitiveMesh/PatchTools/PatchTools.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -115,9 +115,9 @@ public:
//- Determine the mapping for a sub-patch.
// Only include faces for which bool-list entry is true.
// @param[in] includeFaces faces to include
// @param[out] pointMap mapping new to old localPoints
// @param[out] faceMap mapping new to old faces
// \param[in] includeFaces faces to include
// \param[out] pointMap mapping new to old localPoints
// \param[out] faceMap mapping new to old faces
template
<
class BoolListType,

4
src/OpenFOAM/primitives/functions/DataEntry/Constant/Constant.H
View File

@ -28,9 +28,9 @@ Description
Templated basic entry that holds a constant value.
Usage - for entry \<entryName\> having the value <value>:
@verbatim
\verbatim
<entryName> constant <value>
@endverbatim
\endverbatim
SourceFiles
Constant.C

4
src/OpenFOAM/primitives/functions/DataEntry/Table/Table.H
View File

@ -29,13 +29,13 @@ Description
Tuple2's. First column is always stored as scalar entries. Data is read
in the form, e.g. for an entry \<entryName\> that is (scalar, vector):
@verbatim
\verbatim
<entryName> table
(
0.0 (1 2 3)
1.0 (4 5 6)
);
@endverbatim
\endverbatim
SourceFiles
Table.C

4
src/OpenFOAM/primitives/functions/DataEntry/polynomial/polynomial.H
View File

@ -29,13 +29,13 @@ Description
Tuple2's. Data is input in the form, e.g. for an entry \<entryName\> that
describes y = x^2 + 2x^3
@verbatim
\verbatim
<entryName> polynomial
(
(1 2)
(2 3)
);
@endverbatim
\endverbatim
SourceFiles
polynomial.C

6
src/OpenFOAM/primitives/hashes/Hasher/Hasher.H
View File

@ -54,9 +54,9 @@ namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Bob Jenkins's 96-bit mixer hashing function (lookup3)
// @param[in] data - a character stream
// @param[in] len - the number of bytes
// @param[in] seed - the previous hash, or an arbitrary value
// \param[in] data - a character stream
// \param[in] len - the number of bytes
// \param[in] seed - the previous hash, or an arbitrary value
unsigned Hasher(const void* data, size_t len, unsigned seed = 0);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

14
src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H
View File

@ -48,17 +48,17 @@ namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- An optimized version of Hasher
// @param[in] data - an array of uint32_t values
// @param[in] length - the number of values (not bytes)
// @param[in] seed - the previous hash, or an arbitrary value
// \param[in] data - an array of uint32_t values
// \param[in] length - the number of values (not bytes)
// \param[in] seed - the previous hash, or an arbitrary value
unsigned HasherInt(const uint32_t* data, size_t length, unsigned seed = 0);
//- An optimized version of Hasher, returning dual hash values
// @param[in] data - an array of uint32_t values
// @param[in] length - the number of values (not bytes)
// @param[in] hash1 - the previous hash, or an arbitrary value
// \param[in] data - an array of uint32_t values
// \param[in] length - the number of values (not bytes)
// \param[in] hash1 - the previous hash, or an arbitrary value
// on output, the primary hash value
// @param[in] hash1 - the previous hash, or an arbitrary value
// \param[in] hash1 - the previous hash, or an arbitrary value
// on output, the secondary hash value
unsigned HasherDual
(

4
src/OpenFOAM/primitives/hashes/SHA1/SHA1.C
View File

@ -45,11 +45,11 @@ Description
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
//! @cond fileScope
//! \cond fileScope
// The bytes used to pad buffer to the next 64-byte boundary.
// (RFC 1321, 3.1: Step 1)
static const unsigned char fillbuf[64] = { 0x80, 0 /* , 0, 0, ... */ };
//! @endcond
//! \endcond
// * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * * //

4
src/OpenFOAM/primitives/hashes/SHA1/SHA1Digest.C
View File

@ -30,9 +30,9 @@ License
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
//! @cond fileScope
//! \cond fileScope
static const char hexChars[] = "0123456789abcdef";
//! @endcond
//! \endcond
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //

8
src/OpenFOAM/primitives/strings/string/string.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -180,7 +180,7 @@ public:
// - leading "~user" : home directory for specified user
// - leading "~OpenFOAM" : site/user OpenFOAM configuration directory
//
// @sa
// \sa
// Foam::findEtcFile
string& expand(const bool recurse=false);
@ -199,14 +199,14 @@ public:
// Member Operators
//- Return the sub-string from the i-th character for @a n characters
//- Return the sub-string from the i-th character for \a n characters
inline string operator()
(
const size_type i,
const size_type n
) const;
//- Return the sub-string from the first character for @a n characters
//- Return the sub-string from the first character for \a n characters
inline string operator()
(
const size_type n

6
src/Pstream/gamma/OPwrite.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -46,9 +46,9 @@ namespace Foam
// Largest message sent so far. This tracks the size of the receive
// buffer on the receiving end. Done so we only send out resize messages
// if necessary
//! @cond fileScope
//! \cond fileScope
labelList maxSendSize;
//! @endcond
//! \endcond
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //

6
src/Pstream/mpi/PstreamGlobals.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -33,9 +33,9 @@ namespace Foam
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
// Outstanding non-blocking operations.
//! @cond fileScope
//! \cond fileScope
DynamicList<MPI_Request> PstreamGlobals::outstandingRequests_;
//! @endcond
//! \endcond
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

2
src/conversion/ensight/part/ensightPart.H
View File

@ -206,7 +206,7 @@ public:
};
//- Reconstruct part characteristics on freestore from Istream
// @sa reconstruct
// \sa reconstruct
static autoPtr<ensightPart> New(Istream&);

2
src/conversion/ensight/part/ensightPartCells.H
View File

@ -138,7 +138,7 @@ public:
//- Reconstruct part characteristics (eg, element types) from Istream
// A part reconstructed in this manner can be used when writing fields,
// but cannot be used to write a new geometry
// @sa Foam::ensightPart::reconstruct
// \sa Foam::ensightPart::reconstruct
ensightPartCells(Istream&);
//- Reconstruct part characteristics on freestore from Istream

2
src/conversion/ensight/part/ensightPartFaces.H
View File

@ -144,7 +144,7 @@ public:
//- Reconstruct part characteristics (eg, element types) from Istream
// A part reconstructed in this manner can be used when writing fields,
// but cannot be used to write a new geometry
// @sa Foam::ensightPart::reconstruct
// \sa Foam::ensightPart::reconstruct
ensightPartFaces(Istream&);
//- Reconstruct part characteristics on freestore from Istream

12
src/conversion/meshTables/boundaryRegion.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -29,11 +29,11 @@ Description
The meshReader supports boundaryRegion information.
The <tt>constant/boundaryRegion</tt> file is an @c IOMap<dictionary>
The <tt>constant/boundaryRegion</tt> file is an \c IOMap<dictionary>
that is used to save the information persistently.
It contains the boundaryRegion information of the following form:
@verbatim
\verbatim
(
INT
{
@ -42,7 +42,7 @@ Description
}
...
)
@endverbatim
\endverbatim
SourceFiles
boundaryRegion.C
@ -149,9 +149,9 @@ public:
//- Rename regions
// each dictionary entry is a single word:
// @verbatim
// \verbatim
// newPatchName originalName;
// @endverbatim
// \endverbatim
void rename(const dictionary&);
};

12
src/conversion/meshTables/cellTable.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -29,11 +29,11 @@ Description
The meshReader supports cellTable information.
The <tt>constant/cellTable</tt> file is an @c IOMap<dictionary> that is
The <tt>constant/cellTable</tt> file is an \c IOMap<dictionary> that is
used to save the information persistently. It contains the cellTable
information of the following form:
@verbatim
\verbatim
(
ID
{
@ -46,10 +46,10 @@ Description
}
...
)
@endverbatim
\endverbatim
If the @a Label is missing, a value <tt>cellTable_{ID}</tt> will be
inferred. If the @a MaterialType is missing, the value @a fluid will
If the \a Label is missing, a value <tt>cellTable_{ID}</tt> will be
inferred. If the \a MaterialType is missing, the value @a fluid will
be inferred.
SourceFiles

6
src/conversion/meshWriter/meshWriter.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -39,7 +39,7 @@ Description
"constant/boundaryRegion" is an IOMap<dictionary> that contains
the boundary type and names. eg,
@verbatim
\verbatim
(
0
{
@ -61,7 +61,7 @@ Description
Label outlet;
}
)
@endverbatim
\endverbatim
SourceFiles

14
src/dynamicMesh/meshCut/meshModifiers/meshCutter/meshCutter.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -44,7 +44,7 @@ Description
-# Start:
cell with anchor points at bottom
@verbatim
\verbatim
+-------+
| +
| +
@ -55,13 +55,13 @@ Description
| +
+-------+
anchor anchor
@endverbatim
\endverbatim
-# Topo change:
splitface introduced at bottom of cell, introducing a new
cell and splitting the side faces into two.
@verbatim
\verbatim
+-------+
| +
| +
@ -72,12 +72,12 @@ Description
+-------+ <- splitFace
+-------+ <- original cell
anchor anchor
@endverbatim
\endverbatim
-# Inflation:
splitface shifted up to middle of cell (or wherever cut was)
@verbatim
\verbatim
+-------+
| +
| + <- addedCell
@ -88,7 +88,7 @@ Description
| +
+-------+
anchor anchor
@endverbatim
\endverbatim
Anyway this was the original idea. Inflation was meant to handle
conservative properties distribution without interpolation.

6
src/dynamicMesh/motionSmoother/motionSmoother.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -33,7 +33,7 @@ Description
scale back displacement.
E.g.
@verbatim
\verbatim
// Construct iterative mesh mover.
motionSmoother meshMover(mesh, labelList(1, patchI));
@ -48,7 +48,7 @@ Description
return true;
}
}
@endverbatim
\endverbatim
Note
- Shared points (parallel): a processor can have points which are part of

10
src/dynamicMesh/polyMeshAdder/faceCoupleInfo.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -43,7 +43,7 @@ Description
- the cut is always the 'most connected' of the master and slave so
multiple master or slave points might point to the same cut point.
@verbatim
\verbatim
e.g. master:
+--+
@ -63,7 +63,7 @@ Description
| |
| |
+--+
@endverbatim
\endverbatim
adding both together creates a singly connected 2x2 cavity so suddenly
the duplicate master points and the duplicate slave points all become
a single cut point.
@ -81,7 +81,7 @@ Description
- slave can have extra edges/points/faces BUT all subfaces have to have
at least one point on a maste face.
@verbatim
\verbatim
So master:
+-------+
| |
@ -104,7 +104,7 @@ Description
|/ | \|
+---+---+
is ok.
@endverbatim
\endverbatim
For this kind of matching the order is:
- match cutpoint to masterpoint

10
src/dynamicMesh/polyTopoChange/polyTopoChange/addPatchCellLayer.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -45,7 +45,7 @@ Description
E.g. 2 boundary faces on patches a,b. 2 layers for a, 3 for b.
@verbatim
\verbatim
Was:
a b <- patch of boundary face
@ -62,7 +62,7 @@ Description
+------+------+
| | | <- original cells
+------+------+
@endverbatim
\endverbatim
- added faces get same patchID as face they are extruded from
@ -72,7 +72,7 @@ Description
E.g. 3 boundary faces on patches a,b. b gets extruded, a doesn't.
@verbatim
\verbatim
a b b <- patch of boundary face
+------+------+------+
| | | | <- cells
@ -91,7 +91,7 @@ Description
+------+------+------+ 2. side-face gets patch a, not b.
| | | |
+------+------+------+
@endverbatim
\endverbatim
SourceFiles

6
src/dynamicMesh/polyTopoChange/polyTopoChange/refinementHistory.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -35,7 +35,7 @@ Description
indices into splitCells.
E.g. 2 cells, cell 1 gets refined so end up with 9 cells:
@verbatim
\verbatim
// splitCells
9
(
@ -52,7 +52,7 @@ Description
// visibleCells
9(-1 1 2 3 4 5 6 7 8)
@endverbatim
\endverbatim
So cell0 (visibleCells=-1) is unrefined.

4
src/edgeMesh/edgeFormats/starcd/STARCDedgeFormat.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2009-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,7 +28,7 @@ Description
Read/write the lines from pro-STAR vrt/cel files.
Note
Uses the extension @a .inp (input) to denote the format.
Uses the extension \a .inp (input) to denote the format.
See Also
Foam::meshReaders::STARCD

8
src/engine/engineTime/engineTime.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -29,18 +29,18 @@ Description
When engineTime is in effect, the userTime is reported in degrees
crank-angle instead of in seconds. The RPM to be used is specified in
@c constant/engineGeometry. If only a time conversion is required,
\c constant/engineGeometry. If only a time conversion is required,
the geometric engine parameters can be dropped or set to zero.
For example,
@verbatim
\verbatim
rpm rpm [0 0 -1 0 0] 2000;
conRodLength conRodLength [0 1 0 0 0] 0.0;
bore bore [0 1 0 0 0] 0.0;
stroke stroke [0 1 0 0 0] 0.0;
clearance clearance [0 1 0 0 0] 0.0;
@endverbatim
\endverbatim
Note
The engineTime can currently only be selected at compile-time.

6
src/fileFormats/starcd/STARCDCore.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2006-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2006-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -94,7 +94,7 @@ public:
//- Read points from a (.vrt) file
// The file format is as follows:
// @verbatim
// \verbatim
// Line 1:
// PROSTAR_VERTEX newline
//
@ -103,7 +103,7 @@ public:
//
// Body:
// {vertexId} {x} {y} {z} newline
// @endverbatim
// \endverbatim
static bool readPoints(IFstream&, pointField&, labelList& ids);
//- Write header and points to (.vrt) file

18
src/finiteVolume/cfdTools/general/porousMedia/porousZone.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -40,15 +40,15 @@ Description
Implemented porosity models:
powerLaw (@e C0 and @e C1 parameters)
@f[
powerLaw (\e C0 and \e C1 parameters)
\f[
S = - \rho C_0 |U|^{(C_1 - 1)/2} U
@f]
\f]
Darcy-Forchheimer (@e d and @e f parameters)
@f[
Darcy-Forchheimer (@e d and \e f parameters)
\f[
S = - (\mu \, d + \frac{\rho |U|}{2} \, f) U
@f]
\f]
Since negative Darcy/Forchheimer parameters are invalid, they can be used
@ -58,7 +58,7 @@ Description
method, but accounts for the effective volume of the cells.
An example dictionary entry:
@verbatim
\verbatim
cat1
{
note "some catalyst";
@ -74,7 +74,7 @@ Description
f f [0 -1 0 0 0] (-1000 -1000 15.83);
}
}
@endverbatim
\endverbatim
See Also
porousZones and coordinateSystems

6
src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -38,7 +38,7 @@ Description
advectionSpeed() the default implementation of which requires the name of
flux field a the outlet (phi) and optionally the density (rho) if the
mass-flux rather than the volumetric-flux is given.
@verbatim
\verbatim
outlet
{
type advective;
@ -47,7 +47,7 @@ Description
// fieldInf 1e5; // Optional
// lInf 0.1; // Optional
}
@endverbatim
\endverbatim
The flow/wave speed at the outlet can be changed by deriving a specialised
BC fron this class and overriding advectionSpeed() e.g. in

6
src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -30,7 +30,7 @@ Description
given a central axis, central point, rpm, axial and radial velocity.
Example of the boundary condition specification:
@verbatim
\verbatim
inlet
{
type cylindricalInletVelocity;
@ -40,7 +40,7 @@ Description
rpm 100;
radialVelocity -10;
}
@endverbatim
\endverbatim
SourceFiles

6
src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -29,14 +29,14 @@ Description
properties.
Example of the boundary condition specification:
@verbatim
\verbatim
inlet
{
type fixedPressureCompressibleDensity;
p p; // Name of static pressure field
value uniform 1; // Initial value
}
@endverbatim
\endverbatim
SourceFiles
fixedPressureCompressibleDensityFvPatchScalarField.C

6
src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2006-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2006-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -34,14 +34,14 @@ Description
mass basis.
Example of the boundary condition specification:
@verbatim
\verbatim
inlet
{
type flowRateInletVelocity;
flowRate 0.2; // Volumetric/mass flow rate [m3/s or kg/s]
value uniform (0 0 0); // placeholder
}
@endverbatim
\endverbatim
Note
- The value is positive inwards

6
src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -35,14 +35,14 @@ Description
mass basis.
Example of the boundary condition specification:
@verbatim
\verbatim
inlet
{
type swirlFlowRateInletVelocity;
flowRate 0.2; // Volumetric/mass flow rate [m3/s or kg/s]
rpm 100;
}
@endverbatim
\endverbatim
Note
- The value is positive inwards

6
src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -35,7 +35,7 @@ Description
expansion/compression.
Example of the BC specification:
@verbatim
\verbatim
outlet
{
type syringePressure;
@ -51,7 +51,7 @@ Description
ams 0; // Added (or removed) gas mass
// Initially 0 but used for restarting.
}
@endverbatim
\endverbatim
SourceFiles
syringePressureFvPatchScalarField.C

6
src/finiteVolume/fields/fvPatchFields/derived/timeVaryingFlowRateInletVelocity/timeVaryingFlowRateInletVelocityFvPatchVectorField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2006-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2006-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,7 +28,7 @@ Description
A time-varying form of a flow normal vector boundary condition.
Example of the boundary condition specification:
@verbatim
\verbatim
inlet
{
type timeVaryingFlowRateInletVelocity;
@ -37,7 +37,7 @@ Description
fileName "$FOAM_CASE/time-series";
outOfBounds repeat; // (error|warn|clamp|repeat)
}
@endverbatim
\endverbatim
Note
- The value is positive inwards

6
src/finiteVolume/fields/fvPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValueFvPatchField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,14 +28,14 @@ Description
A time-varying form of a uniform fixed value boundary condition.
Example of the boundary condition specification:
@verbatim
\verbatim
inlet
{
type timeVaryingUniformFixedValue;
fileName "$FOAM_CASE/time-series";
outOfBounds clamp; // (error|warn|clamp|repeat)
}
@endverbatim
\endverbatim
Note
This class is derived directly from a fixedValue patch rather than from

4
src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H
View File

@ -29,14 +29,14 @@ Description
fraction of the mean velocity
Example of the boundary condition specification:
@verbatim
\verbatim
inlet
{
type turbulentIntensityKineticEnergyInlet;
intensity 0.05; // 5% turbulence
value uniform 1; // placeholder
}
@endverbatim
\endverbatim
SourceFiles
turbulentIntensityKineticEnergyInletFvPatchScalarField.C

4
src/fvMotionSolver/fvMotionSolvers/displacement/interpolation/displacementInterpolationFvMotionSolver.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -34,7 +34,7 @@ Description
- interpolates the displacement of all points based on the
faceZone motion.
Tables are in the @a constant/tables directory.
Tables are in the \a constant/tables directory.
Note
could be a motionSolver - does not use any fvMesh structure.

8
src/lagrangian/basic/InteractionLists/InteractionLists.H
View File

@ -36,18 +36,18 @@ Description
Simultaneous communication and computation is possible using:
@verbatim
\verbatim
PstreamBuffers pBufs(Pstream::nonBlocking);
il_.sendReferredData(cellOccupancy_, pBufs);
// Do other things
il_.receiveReferredData(pBufs);
@endverbatim
\endverbatim
Requiring data:
@verbatim
\verbatim
List<DynamicList<typename CloudType::parcelType*> > cellOccupancy_;
@endverbatim
\endverbatim
SourceFiles
InteractionListsI.H

8
src/lagrangian/dieselSpray/spraySubModels/atomizationModel/LISA/LISA.H
View File

@ -28,19 +28,19 @@ Description
Primary Breakup Model for pressure swirl atomizers.
Accurate description in
@verbatim
\verbatim
P.K. Senecal, D.P. Shmidt, I. Nouar, C.J. Rutland, R.D. Reitz, M. Corradini
"Modeling high-speed viscous liquid sheet atomization"
International Journal of Multiphase Flow 25 (1999) pags. 1073-1097
@endverbatim
\endverbatim
and
@verbatim
\verbatim
D.P. Schmidt, I. Nouar, P.K. Senecal, C.J. Rutland, J.K. Martin, R.D. Reitz
"Pressure-Swirl Atomization in the Near Field"
SAE Techical Paper Series 1999-01-0496
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/

4
src/lagrangian/dieselSpray/spraySubModels/atomizationModel/blobsSheetAtomization/blobsSheetAtomization.H
View File

@ -28,7 +28,7 @@ Description
Primary Breakup Model for pressure swirl atomizers.
Accurate description in
@verbatim
\verbatim
Z. Han, S. Parrish, P.V. Farrell, R.D. Reitz
"Modeling Atomization Processes Of Pressure Swirl Hollow-Cone Fuel Sprays"
Atomization and Sprays, vol. 7, pp. 663-684, 1997
@ -38,7 +38,7 @@ Description
L. Allocca, G. Bella, A. De Vita, L. Di Angelo
"Experimental Validation of a GDI Spray Model"
SAE Technical Paper Series, 2002-01-1137
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/

4
src/lagrangian/dieselSpray/spraySubModels/breakupModel/ETAB/ETAB.H
View File

@ -28,7 +28,7 @@ Description
The Enhanced %TAB model.
Described in the papers below.
@verbatim
\verbatim
F.X. Tanner
"Liquid Jet Atomization and Droplet Breakup Modeling of
Non-Evaporating Diesel Fuel Sprays"
@ -40,7 +40,7 @@ Description
Fuel Sprays by Means of Cascade Drop Breakup Model"
SAE 980808
SAE Technical Paper Series
@endverbatim
\endverbatim
See Also
The TAB model

4
src/lagrangian/dieselSpray/spraySubModels/breakupModel/SHF/SHF.H
View File

@ -29,12 +29,12 @@ Description
bag, molutimode, shear....
Accurate description in
@verbatim
\verbatim
R. Schmehl, G. Maier, S. Witting
"CFD Analysis of Fuel Atomization, Secondary Droplet Breakup and Spray
Dispersion in the Premix Duct of a LPP Combustor".
Eight International Conference on Liquid Atomization and Spray Systems, 2000
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/

4
src/lagrangian/dieselSpray/spraySubModels/breakupModel/TAB/TAB.H
View File

@ -27,14 +27,14 @@ Class
Description
The TAB Method for Numerical Calculation of Spray Droplet Breakup.
@verbatim
\verbatim
O'Rourke, P.J. and Amsden, A.A.,
"The TAB Method for Numerical Calculation of Spray Droplet Breakup,"
1987 SAE International Fuels and Lubricants Meeting and Exposition,
Toronto, Ontario, November 2-5, 1987,
Los Alamos National Laboratory document LA-UR-87-2105;
SAE Technical Paper Series, Paper 872089.
@endverbatim
\endverbatim
This implementation follows the kiva version.

6
src/lagrangian/dieselSpray/spraySubModels/evaporationModel/RutlandFlashBoil/RutlandFlashBoil.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -32,11 +32,11 @@ Description
- superheated vaporization of a boiling droplet
Accurated description in
@verbatim
\verbatim
B. Zuo, A.M. Gomes, C.J. Rutland
"Modeling Superheated Fuel Spray Vaporization"
Int. Journal of Engine Research, 2000. Vol. 1, pp. 321-326
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/
#ifndef RutlandFlashBoil_H

10
src/lagrangian/dieselSpray/spraySubModels/injectorModel/blobsSwirl/blobsSwirlInjector.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,18 +28,18 @@ Description
Model for parcels injection in pressure Swirl Atomizers.
Accurate description in:
@verbatim
\verbatim
Z. Han, S. Parrish, P.V. Farrell, R.D. Reitz
"Modeling Atomization Processes Of Pressure
Swirl Hollow-Cone Fuel Sprays"
Atomization and Sprays, vol. 7, pp. 663-684, 1997
@endverbatim
\endverbatim
and
@verbatim
\verbatim
L. Allocca, G. Bella, A. De Vita, L. Di Angelo
"Experimental Validation of a GDI Spray Model"
SAE Technical Paper Series, 2002-01-1137
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/

4
src/lagrangian/distributionModels/RosinRammler/RosinRammler.H
View File

@ -27,11 +27,11 @@ Class
Description
Rosin-Rammler distributionModel
@f[
\f[
cumulative model =
(1.0 - exp( -(( x - d0)/d)^n )
/ (1.0 - exp( -((d1 - d0)/d)^n )
@f]
\f]
SourceFiles

4
src/lagrangian/distributionModels/multiNormal/multiNormal.H
View File

@ -27,9 +27,9 @@ Class
Description
A multiNormal distribution model
@verbatim
\verbatim
model = sum_i strength_i * exp(-0.5*((x - expectation_i)/variance_i)^2 )
@endverbatim
\endverbatim
SourceFiles

4
src/lagrangian/distributionModels/normal/normal.H
View File

@ -27,9 +27,9 @@ Class
Description
A normal distribution model
@verbatim
\verbatim
model = strength * exp(-0.5*((x - expectation)/variance)^2 )
@endverbatim
\endverbatim
strength only has meaning if there's more than one distribution model

6
src/lagrangian/intermediate/submodels/Kinematic/DragModel/NonSphereDrag/NonSphereDrag.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -46,13 +46,13 @@ Description
constant, it offers little benefit.
Reference:
@verbatim
\verbatim
"Drag coefficient and terminal velocity of spherical and nonspherical
particles"
A. Haider and O. Levenspiel,
Powder Technology
Volume 58, Issue 1, May 1989, Pages 63-70
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/

2
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H
View File

@ -28,7 +28,7 @@ Description
Manual injection
- User specifies
- Total mass to inject
- Parcel positions in file @c positionsFile
- Parcel positions in file \c positionsFile
- Initial parcel velocity
- Parcel diameters obtained by distribution model model
- All parcels introduced at SOI

8
src/lagrangian/molecularDynamics/potential/pairPotential/derived/azizChen/azizChen.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,8 +28,8 @@ Description
Foam::pairPotentials::azizChen
From:
@verbatim
@article{MA_Aziz_Chen,
\verbatim
\article{MA_Aziz_Chen,
author = {R. A. Aziz and H. H. Chen},
collaboration = {},
title = {An accurate intermolecular potential for argon},
@ -42,7 +42,7 @@ Description
url = {http://link.aip.org/link/?JCP/67/5719/1},
doi = {10.1063/1.434827}
}
@endverbatim
\endverbatim
SourceFiles
azizChen.C

10
src/lagrangian/molecularDynamics/potential/pairPotential/derived/maitlandSmith/maitlandSmith.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,7 +28,7 @@ Description
Foam::pairPotentials::maitlandSmith
From:
@verbatim
\verbatim
@ARTICLE{MA_Maitland_Smith,
author = {{Maitland}, G.~C. and {Smith}, E.~B.},
title = {A simplified representation of
@ -41,10 +41,10 @@ Description
adsurl = {http://adsabs.harvard.edu/abs/1973CPL....22..443M},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
@endverbatim
\endverbatim
Parameters for other monoatomics from:
@verbatim
\verbatim
@BOOK{MD_Maitland_Rigby_Smith_Wakeham,
AUTHOR = {Geoffrey C. Maitland and Maurice Rigby and
E. Brian Smith and William A. Wakeham},
@ -52,7 +52,7 @@ Description
PUBLISHER = {Oxford University Press},
YEAR = {1981}
}
@endverbatim
\endverbatim
SourceFiles
maitlandSmith.C

6
src/mesh/blockMesh/blockDescriptor/blockDescriptorEdges.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -33,13 +33,13 @@ License
namespace Foam
{
//! @cond fileScope
//! \cond fileScope
// Calculate the geometric expension factor from the expansion ratio
inline scalar calcGexp(const scalar expRatio, const label dim)
{
return dim > 1 ? pow(expRatio, 1.0/(dim - 1)) : 0.0;
}
//! @endcond
//! \endcond
} // End namespace Foam

8
src/mesh/blockMesh/curvedEdges/BSpline.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2009-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -30,14 +30,14 @@ Description
In this implementation, the end tangents are created automatically
by reflection.
In matrix form, the @e local interpolation on the interval t=[0..1] is
In matrix form, the \e local interpolation on the interval t=[0..1] is
described as follows:
@verbatim
\verbatim
P(t) = 1/6 * [ t^3 t^2 t 1 ] * [ -1 3 -3 1 ] * [ P-1 ]
[ 3 -6 3 0 ] [ P0 ]
[ -3 0 3 0 ] [ P1 ]
[ 1 4 1 0 ] [ P2 ]
@endverbatim
\endverbatim
Where P-1 and P2 represent the neighbouring points or the extrapolated
end points. Simple reflection is used to automatically create the end

8
src/mesh/blockMesh/curvedEdges/CatmullRomSpline.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2009-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -31,14 +31,14 @@ Description
In this implementation, the end tangents are created automatically
by reflection.
In matrix form, the @e local interpolation on the interval t=[0..1] is
In matrix form, the \e local interpolation on the interval t=[0..1] is
described as follows:
@verbatim
\verbatim
P(t) = 1/2 * [ t^3 t^2 t 1 ] * [ -1 3 -3 1 ] * [ P-1 ]
[ 2 -5 4 -1 ] [ P0 ]
[ -1 0 1 0 ] [ P1 ]
[ 0 2 0 0 ] [ P2 ]
@endverbatim
\endverbatim
Where P-1 and P2 represent the neighbouring points or the extrapolated
end points. Simple reflection is used to automatically create the end

8
src/meshTools/cellClassification/cellClassification.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -39,7 +39,7 @@ Description
Has various utility functions to deal with 'features' on this level
where the mesh still has all inside and outside cells.
@par Concepts
\par Concepts
- point classification:
- point used by meshType cells only
@ -56,7 +56,7 @@ Description
same type.
Seen from above:
@verbatim
\verbatim
Ok:
A | A
|
@ -70,7 +70,7 @@ Description
---+---
|
B | A
@endverbatim
\endverbatim
because this latter situation would cause the surface after subsetting
type A or B to be multiply connected across this edge. And also when

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -36,14 +36,14 @@ Description
- the rotation angles are in degrees, unless otherwise explictly specified:
@verbatim
\verbatim
coordinateRotation
{
type EulerRotation
degrees false;
rotation (0 0 3.141592654);
}
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -33,14 +33,14 @@ Description
- the rotation angles are in degrees, unless otherwise explictly specified:
@verbatim
\verbatim
coordinateRotation
{
type STARCDRotation;
degrees false;
rotation (0 0 3.141592654);
}
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/

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

@ -32,7 +32,7 @@ Description
or (e3/e1). Any nonorthogonality will be absorbed into the second vector.
For convenience, the dictionary constructor forms allow a few shortcuts:
- if the @c type is not otherwise specified, the type @c axes
- if the \c type is not otherwise specified, the type @c axes
is implicit
- if an axes specification (eg, e3/e1) is used, the coordinateRotation
sub-dictionary can be dropped.
@ -41,28 +41,28 @@ Description
(type "EulerRotation") or by a STARCDCoordinateRotation
(type "STARCDRotation") requires the coordinateRotation sub-dictionary.
@verbatim
\verbatim
coordinateRotation
{
type STARCDRotation
rotation (0 0 90);
}
@endverbatim
\endverbatim
- the rotation angles are in degrees, unless otherwise explictly specified:
@verbatim
\verbatim
coordinateRotation
{
type STARCDRotation
degrees false;
rotation (0 0 3.141592654);
}
@endverbatim
\endverbatim
Deprecated
Specifying the local vectors as an @c axis (corresponding to e3) and a
@c direction (corresponding to e1), is allowed for backwards
Specifying the local vectors as an \c axis (corresponding to e3) and a
\c direction (corresponding to e1), is allowed for backwards
compatibility, but this terminology is generally a bit confusing.
(deprecated Apr 2008)

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

@ -31,10 +31,10 @@ Description
All systems are defined by an origin point and a coordinateRotation.
For convenience, the dictionary constructor forms allow a few shortcuts:
- the default origin corresponds to <em>(0 0 0)</em>
- if the @c type is not otherwise specified, a Cartesian coordinateSystem
- if the \c type is not otherwise specified, a Cartesian coordinateSystem
is implicit
@verbatim
\verbatim
flipped
{
origin (0 0 0);
@ -44,12 +44,12 @@ Description
rotation (0 0 90);
}
}
@endverbatim
\endverbatim
- if an axes specification (eg, e3/e1) is used, the coordinateRotation
sub-dictionary can be dropped.
@verbatim
\verbatim
flipped // the same, specified as axes
{
origin (0 0 0);
@ -65,14 +65,14 @@ Description
e3 (1 0 0);
e1 (0 0 -1);
}
@endverbatim
\endverbatim
- if a sub-dictionary coordinateSystem is found within the dictionary, it
will be used. This provides a convenient means of embedding
coordinateSystem information in another dictionary.
This is used, for example, in the porousZones:
@verbatim
\verbatim
1
(
cat1
@ -94,12 +94,12 @@ Description
}
}
)
@endverbatim
\endverbatim
- additionally, if the coordinateSystem points to a plain entry,
it can be used to reference one of the global coordinateSystems
@verbatim
\verbatim
1
(
cat1
@ -113,7 +113,7 @@ Description
}
}
)
@endverbatim
\endverbatim
For this to work correctly, the coordinateSystem constructor must be
supplied with both a dictionary and an objectRegistry.
@ -364,21 +364,21 @@ public:
}
//- Return axis (e3: local Cartesian z-axis)
// @deprecated method e3 is preferred (deprecated Apr 2008)
// \deprecated method e3 is preferred (deprecated Apr 2008)
const vector axis() const
{
return Rtr_.z();
}
//- Return direction (e1: local Cartesian x-axis)
// @deprecated method e1 is preferred (deprecated Apr 2008)
// \deprecated method e1 is preferred (deprecated Apr 2008)
const vector direction() const
{
return Rtr_.x();
}
//- Return as dictionary of entries
// @param [in] ignoreType drop type (cartesian, cylindrical, etc)
// \param [in] ignoreType drop type (cartesian, cylindrical, etc)
// when generating the dictionary
virtual dictionary dict(bool ignoreType=false) const;

4
src/meshTools/coordinateSystems/coordinateSystems.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -104,7 +104,7 @@ public:
label findIndex(const keyType& key) const;
//- Find and return index for the first match, returns -1 if not found
// @deprecated use findIndex() instead (deprecated Jul 2010)
// \deprecated use findIndex() instead (deprecated Jul 2010)
label find(const keyType& key) const;
//- Search for given key

10
src/meshTools/edgeFaceCirculator/edgeFaceCirculator.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -33,7 +33,7 @@ Description
- direction (cell to walk into)
-# Use in-place: \n
@code
\code
edgeFaceCirculator circ(..);
// Optionally rotate to beginning: circ.setCanonical();
@ -44,10 +44,10 @@ Description
++circ;
}
while (circ != circ.end());
@endcode
\endcode
-# Use like STL iterator: \n
@code
\code
edgeFaceCirculator circ(..);
for
(
@ -58,7 +58,7 @@ Description
{
Info<< "face:" << iter.face() << endl;
}
@endcode
\endcode
SourceFiles

4
src/meshTools/octree/octree.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -66,7 +66,7 @@ Description
-# bb.max incremented by 1% -> total 80 leaves
(every point in exactly 1 leaf)
@par Ideas for parallel implementation:
\par Ideas for parallel implementation:
The data inserted into the octree (the
'octreeData') has to be local to the processor. The data to be looked

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