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

ENH: Updated function object documentation

Browse Source
This commit is contained in:
andy
2012-07-26 13:00:11 +01:00
parent c4665c5d69
commit 01cf1d6f9e
4 changed files with 102 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
View File

@ -28,8 +28,40 @@ Group
grpFieldFunctionObjects
Description
Transforms fields from global cartesian co-ordinates to local co-ordinate
system
This function object transforms a user-specified selection of fields from
global Cartesian co-ordinates to a local co-ordinate system. The fields
are run-time modifiable.
Example of function object specification:
\verbatim
fieldCoordinateSystemTransform1
{
// Type of functionObject
type fieldCoordinateSystemTransform;
// Where to load it from (if not already in solver)
functionObjectLibs ("libfieldFunctionObjects.so");
// Fields to be transformed
fields
(
U
UMean
UPrime2Mean
);
// Co-ordinate system
coordinateSystem
{
origin (0.001 0 0);
e1 (1 0.15 0);
e3 (0 0 -1);
}
}
\endverbatim
SeeAlso
Foam::coordinateSystem
SourceFiles
fieldCoordinateSystemTransform.C