Updated Doxygen documentation and files

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

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

View File

@ -27,8 +27,12 @@ Class
Description
Interpolates pre-specified motion.
Motion specified as pointVectorFields. E.g.
Motion specified as pointVectorFields.
\heading Patch usage
Example:
\verbatim
walls
{
type uniformInterpolatedDisplacement;
@ -36,9 +40,10 @@ Description
fieldName wantedDisplacement;
interpolationScheme linear;
}
\endverbatim
This will scan the case for 'wantedDisplacement' pointVectorFields
and interpolate those in time (using 'linear' interpolation) to
This will scan the case for \a wantedDisplacement pointVectorFields
and interpolate those in time (using \c linear interpolation) to
obtain the current displacement.
The advantage of specifying displacement in this way is that it
automatically works through decomposePar.