mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
STYLE: changed some missed doxygen '@' to '\'
This commit is contained in:
@ -40,7 +40,7 @@ Usage
|
|||||||
|
|
||||||
Note
|
Note
|
||||||
The cellTable information available in the files
|
The cellTable information available in the files
|
||||||
\c constant/cellTable and @c constant/polyMesh/cellTableId
|
\c constant/cellTable and \c constant/polyMesh/cellTableId
|
||||||
will be used if available. Otherwise the cellZones are used when
|
will be used if available. Otherwise the cellZones are used when
|
||||||
creating the cellTable information.
|
creating the cellTable information.
|
||||||
|
|
||||||
|
|||||||
@ -29,7 +29,7 @@ Description
|
|||||||
type in the field and polyMesh/boundary files.
|
type in the field and polyMesh/boundary files.
|
||||||
|
|
||||||
Reads dictionaries (fields) and entries to change from a dictionary.
|
Reads dictionaries (fields) and entries to change from a dictionary.
|
||||||
E.g. to make the \em movingWall a \em fixedValue for @em p but all other
|
E.g. to make the \em movingWall a \em fixedValue for \em p but all other
|
||||||
\em Walls a zeroGradient boundary condition, the
|
\em Walls a zeroGradient boundary condition, the
|
||||||
\c system/changeDictionaryDict would contain the following:
|
\c system/changeDictionaryDict would contain the following:
|
||||||
\verbatim
|
\verbatim
|
||||||
|
|||||||
@ -3,7 +3,7 @@
|
|||||||
# ========= |
|
# ========= |
|
||||||
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
# \\ / O peration |
|
# \\ / O peration |
|
||||||
# \\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd.
|
# \\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
|
||||||
# \\/ M anipulation |
|
# \\/ M anipulation |
|
||||||
#-------------------------------------------------------------------------------
|
#-------------------------------------------------------------------------------
|
||||||
# License
|
# License
|
||||||
@ -33,10 +33,10 @@
|
|||||||
# personal settings to site-wide settings.
|
# personal settings to site-wide settings.
|
||||||
#
|
#
|
||||||
# For example, within the user ~/.OpenFOAM/<VER>/prefs.sh:
|
# For example, within the user ~/.OpenFOAM/<VER>/prefs.sh:
|
||||||
# @verbatim
|
# \code
|
||||||
# foamPrefs=`$WM_PROJECT_DIR/bin/foamEtcFile -m go prefs.sh` \
|
# foamPrefs=`$WM_PROJECT_DIR/bin/foamEtcFile -m go prefs.sh` \
|
||||||
# && _foamSource $foamPrefs
|
# && _foamSource $foamPrefs
|
||||||
# @endverbatim
|
# \endcode
|
||||||
#
|
#
|
||||||
#-------------------------------------------------------------------------------
|
#-------------------------------------------------------------------------------
|
||||||
usage() {
|
usage() {
|
||||||
|
|||||||
@ -29,7 +29,7 @@ Description
|
|||||||
|
|
||||||
SeeAlso
|
SeeAlso
|
||||||
The manpage regex(7) for more information about POSIX regular expressions.
|
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
|
SourceFiles
|
||||||
regExp.C
|
regExp.C
|
||||||
|
|||||||
@ -27,7 +27,7 @@ Class
|
|||||||
Description
|
Description
|
||||||
Specify a file to include if it exists. Expects a single string to follow.
|
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.
|
directive, but does not generate an error if the file does not exist.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
========= |
|
========= |
|
||||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
\\ / O peration |
|
\\ / O peration |
|
||||||
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
|
\\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
|
||||||
\\/ M anipulation |
|
\\/ M anipulation |
|
||||||
-------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------
|
||||||
License
|
License
|
||||||
@ -21,9 +21,9 @@ License
|
|||||||
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
||||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
@mainpage OpenFOAM®: open source CFD
|
\mainpage OpenFOAM®: open source CFD
|
||||||
|
|
||||||
@section about About OpenFOAM
|
\section about About OpenFOAM
|
||||||
|
|
||||||
OpenFOAM is a free, open source CFD software package produced by
|
OpenFOAM is a free, open source CFD software package produced by
|
||||||
a commercial company,
|
a commercial company,
|
||||||
@ -35,7 +35,7 @@ License
|
|||||||
heat transfer, to solid dynamics and electromagnetics.
|
heat transfer, to solid dynamics and electromagnetics.
|
||||||
<a href="http://www.openfoam.com/features">More ...</a>
|
<a href="http://www.openfoam.com/features">More ...</a>
|
||||||
|
|
||||||
@section users Our commitment to the users
|
\section users Our commitment to the users
|
||||||
|
|
||||||
OpenFOAM comes with full commercial support from OpenCFD, including
|
OpenFOAM comes with full commercial support from OpenCFD, including
|
||||||
<a href="http://www.openfoam.com/support/software.php">
|
<a href="http://www.openfoam.com/support/software.php">
|
||||||
@ -48,7 +48,7 @@ License
|
|||||||
These activities fund the development, maintenance and release of
|
These activities fund the development, maintenance and release of
|
||||||
OpenFOAM to make it an extremely viable commercial open source product.
|
OpenFOAM to make it an extremely viable commercial open source product.
|
||||||
|
|
||||||
@section opensource Our commitment to open source
|
\section opensource Our commitment to open source
|
||||||
|
|
||||||
OpenCFD is committed to open source software, continually developing and
|
OpenCFD is committed to open source software, continually developing and
|
||||||
maintaining OpenFOAM under the
|
maintaining OpenFOAM under the
|
||||||
|
|||||||
@ -35,7 +35,7 @@ Description
|
|||||||
write OpenFOAM meshes and/or results to another CFD format
|
write OpenFOAM meshes and/or results to another CFD format
|
||||||
- currently just STAR-CD
|
- currently just STAR-CD
|
||||||
|
|
||||||
@par Files
|
\par Files
|
||||||
|
|
||||||
"constant/boundaryRegion" is an IOMap<dictionary> that contains
|
"constant/boundaryRegion" is an IOMap<dictionary> that contains
|
||||||
the boundary type and names. eg,
|
the boundary type and names. eg,
|
||||||
|
|||||||
@ -32,7 +32,7 @@ Description
|
|||||||
or (e3/e1). Any nonorthogonality will be absorbed into the second vector.
|
or (e3/e1). Any nonorthogonality will be absorbed into the second vector.
|
||||||
|
|
||||||
For convenience, the dictionary constructor forms allow a few shortcuts:
|
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
|
is implicit
|
||||||
- if an axes specification (eg, e3/e1) is used, the coordinateRotation
|
- if an axes specification (eg, e3/e1) is used, the coordinateRotation
|
||||||
sub-dictionary can be dropped.
|
sub-dictionary can be dropped.
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
========= |
|
========= |
|
||||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
\\ / O peration |
|
\\ / O peration |
|
||||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||||
\\/ M anipulation |
|
\\/ M anipulation |
|
||||||
-------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------
|
||||||
License
|
License
|
||||||
@ -36,7 +36,7 @@ License
|
|||||||
using namespace Foam;
|
using namespace Foam;
|
||||||
|
|
||||||
// Dummy yyFlexLexer::yylex() to keep the linker happy. It is not called
|
// Dummy yyFlexLexer::yylex() to keep the linker happy. It is not called
|
||||||
//! @cond dummy
|
//! \cond dummy
|
||||||
int yyFlexLexer::yylex()
|
int yyFlexLexer::yylex()
|
||||||
{
|
{
|
||||||
FatalErrorIn("yyFlexLexer::yylex()")
|
FatalErrorIn("yyFlexLexer::yylex()")
|
||||||
@ -44,12 +44,12 @@ int yyFlexLexer::yylex()
|
|||||||
<< abort(FatalError);
|
<< abort(FatalError);
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
//! @endcond
|
//! \endcond
|
||||||
|
|
||||||
// Dummy yywrap to keep yylex happy at compile time.
|
// Dummy yywrap to keep yylex happy at compile time.
|
||||||
// It is called by yylex but is not used as the mechanism to change file.
|
// It is called by yylex but is not used as the mechanism to change file.
|
||||||
// See <<EOF>>
|
// See <<EOF>>
|
||||||
//! @cond dummy
|
//! \cond dummy
|
||||||
#if YY_FLEX_SUBMINOR_VERSION < 34
|
#if YY_FLEX_SUBMINOR_VERSION < 34
|
||||||
extern "C" int yywrap()
|
extern "C" int yywrap()
|
||||||
#else
|
#else
|
||||||
@ -58,7 +58,7 @@ int yyFlexLexer::yywrap()
|
|||||||
{
|
{
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
//! @endcond
|
//! \endcond
|
||||||
|
|
||||||
|
|
||||||
//- A lexer for parsing STL ASCII files.
|
//- A lexer for parsing STL ASCII files.
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
========= |
|
========= |
|
||||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||||
\\ / O peration |
|
\\ / O peration |
|
||||||
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
|
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
||||||
\\/ M anipulation |
|
\\/ M anipulation |
|
||||||
-------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------
|
||||||
License
|
License
|
||||||
@ -38,7 +38,7 @@ License
|
|||||||
int Foam::chemkinReader::yyBufSize = YY_BUF_SIZE;
|
int Foam::chemkinReader::yyBufSize = YY_BUF_SIZE;
|
||||||
|
|
||||||
// Dummy yyFlexLexer::yylex() to keep the linker happy. It is not called
|
// Dummy yyFlexLexer::yylex() to keep the linker happy. It is not called
|
||||||
//! @cond dummy
|
//! \cond dummy
|
||||||
int yyFlexLexer::yylex()
|
int yyFlexLexer::yylex()
|
||||||
{
|
{
|
||||||
FatalErrorIn("yyFlexLexer::yylex()")
|
FatalErrorIn("yyFlexLexer::yylex()")
|
||||||
@ -47,13 +47,13 @@ int yyFlexLexer::yylex()
|
|||||||
|
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
//! @endcond
|
//! \endcond
|
||||||
|
|
||||||
|
|
||||||
// Dummy yywrap to keep yylex happy at compile time.
|
// Dummy yywrap to keep yylex happy at compile time.
|
||||||
// It is called by yylex but is not used as the mechanism to change file.
|
// It is called by yylex but is not used as the mechanism to change file.
|
||||||
// See <<EOF>>
|
// See <<EOF>>
|
||||||
//! @cond dummy
|
//! \cond dummy
|
||||||
#if YY_FLEX_SUBMINOR_VERSION < 34
|
#if YY_FLEX_SUBMINOR_VERSION < 34
|
||||||
extern "C" int yywrap()
|
extern "C" int yywrap()
|
||||||
#else
|
#else
|
||||||
@ -62,7 +62,7 @@ int yyFlexLexer::yywrap()
|
|||||||
{
|
{
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
//! @endcond
|
//! \endcond
|
||||||
|
|
||||||
|
|
||||||
Foam::string foamSpecieString(const char* YYText)
|
Foam::string foamSpecieString(const char* YYText)
|
||||||
|
|||||||
@ -39,7 +39,7 @@ License
|
|||||||
using namespace Foam;
|
using namespace Foam;
|
||||||
|
|
||||||
// Dummy yyFlexLexer::yylex() to keep the linker happy. It is not called
|
// Dummy yyFlexLexer::yylex() to keep the linker happy. It is not called
|
||||||
//! @cond dummy
|
//! \cond dummy
|
||||||
int yyFlexLexer::yylex()
|
int yyFlexLexer::yylex()
|
||||||
{
|
{
|
||||||
FatalErrorIn("yyFlexLexer::yylex()")
|
FatalErrorIn("yyFlexLexer::yylex()")
|
||||||
@ -47,12 +47,12 @@ int yyFlexLexer::yylex()
|
|||||||
<< abort(FatalError);
|
<< abort(FatalError);
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
//! @endcond
|
//! \endcond
|
||||||
|
|
||||||
// Dummy yywrap to keep yylex happy at compile time.
|
// Dummy yywrap to keep yylex happy at compile time.
|
||||||
// It is called by yylex but is not used as the mechanism to change file.
|
// It is called by yylex but is not used as the mechanism to change file.
|
||||||
// See <<EOF>>
|
// See <<EOF>>
|
||||||
//! @cond dummy
|
//! \cond dummy
|
||||||
#if YY_FLEX_SUBMINOR_VERSION < 34
|
#if YY_FLEX_SUBMINOR_VERSION < 34
|
||||||
extern "C" int yywrap()
|
extern "C" int yywrap()
|
||||||
#else
|
#else
|
||||||
@ -61,7 +61,7 @@ int yyFlexLexer::yywrap()
|
|||||||
{
|
{
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
//! @endcond
|
//! \endcond
|
||||||
|
|
||||||
|
|
||||||
class STLLexer
|
class STLLexer
|
||||||
|
|||||||
Reference in New Issue
Block a user