Commit Graph

37 Commits

Author SHA1 Message Date
39e0368d6b functionObjects: Corrected member function documentation 2016-05-22 21:28:24 +01:00
15773bf1b7 fvMeshFunctionObject: Rename 'write' -> 'writeField' to avoid clash with base-class 2016-05-22 16:30:12 +01:00
28359c53ba functionObjects/field/fieldCoordinateSystemTransform: simplified, standardized, rationalized 2016-05-22 14:26:40 +01:00
83bae2efd3 functionObjects: Renamed dictionary entry 'functionObjectLibs' -> 'libs'
This changes simplifies the specification of functionObjects in
controlDict and is consistent with the 'libs' option in controlDict to
load special solver libraries.

Support for the old 'functionObjectLibs' name is supported for backward compatibility.
2016-05-16 22:09:01 +01:00
78d2971b21 functionObjects: rewritten to all be derived from 'functionObject'
- Avoids the need for the 'OutputFilterFunctionObject' wrapper
  - Time-control for execution and writing is now provided by the
    'timeControlFunctionObject' which instantiates the processing
    'functionObject' and controls its operation.
  - Alternative time-control functionObjects can now be written and
    selected at run-time without the need to compile wrapped version of
    EVERY existing functionObject which would have been required in the
    old structure.
  - The separation of 'execute' and 'write' functions is now formalized in the
    'functionObject' base-class and all derived classes implement the
    two functions.
  - Unnecessary implementations of functions with appropriate defaults
    in the 'functionObject' base-class have been removed reducing
    clutter and simplifying implementation of new functionObjects.
  - The 'coded' 'functionObject' has also been updated, simplified and tested.
  - Further simplification is now possible by creating some general
    intermediate classes derived from 'functionObject'.
2016-05-15 16:40:01 +01:00
6164c2f262 Standardized the naming of functions which control the writing of fields etc.
to have the prefix 'write' rather than 'output'

So outputTime() -> writeTime()

but 'outputTime()' is still supported for backward-compatibility.

Also removed the redundant secondary-writing functionality from Time
which has been superseded by the 'writeRegisteredObject' functionObject.
2016-05-12 17:38:01 +01:00
c983670c91 functionObjects: Changed options 'outputControl' -> 'writeControl' and 'outputInterval' -> 'writeInterval'
for consistency with the time controls in controlDict and to avoid
unnecessary confusion.  All code and tutorials have been updated.

The old names 'outputControl' and 'outputInterval' are but supported for
backward compatibility but deprecated.
2016-05-12 11:38:11 +01:00
437030a57d functionObjects: Removed the redundant "viable" member function
Construction failure and recovery is not handled with exceptions in functionObjectList
2016-05-11 12:57:17 +01:00
080908732d src/postProcessing/functionObjects: Removed unused IOOutputFilter clutter 2016-05-10 12:54:42 +01:00
c70c12a2bb functionObjects: Simplified organization and naming 2016-05-03 23:37:28 +01:00
32762aa1f9 Change field loop index from "fieldI" to "fieldi" 2016-05-02 18:20:48 +01:00
0534a225fd functionObjects: Moved into the functionObjects namespace and rationalized and simplified failable construction
Rather than requiring each functionObject to handle failed construction
internally (using the active_ flag) the static member function "viable"
is provided which returns true if construction of the functionObject is
likely to be successful.  Failed construction is then handled by the
wrapper-class which constructs the functionObject,
e.g. "OutputFilterFunctionObject".
2016-05-02 16:28:24 +01:00
95d146ecdf Rationalized the indentation of C-preprocessor directives 2016-02-29 15:42:03 +00:00
34d4cfaca3 Make disallowed member functions private
Resolves bug-report http://www.openfoam.org/mantisbt/view.php?id=1977
2016-01-20 10:41:14 +00:00
c4d5f65a10 Completed update ...ErrorIn -> ...ErrorInFunction
Avoids the clutter and maintenance effort associated with providing the
function signature string.
2015-11-11 09:03:39 +00:00
9fb26d59d3 GIT: Repo update 2014-12-11 08:35:10 +00:00
6a7f2f2969 fieldCoordinateSystemTransform: Remove N^2 loop over the field 2014-09-09 20:50:57 +01:00
fbb3ddf2c4 Updated for release 2.3.0 2014-02-17 10:21:46 +00:00
659249064f ENH: Function object updates 2014-01-03 10:37:08 +00:00
5126a6a49a ENH: Function object updates 2013-11-29 09:25:09 +00:00
837ca32397 ENH: function obejct updates 2013-10-04 16:44:58 +01:00
a50d78ea93 EMH: Adding a hook to functionObject called 'timeSet' at the
end of Time::operator++. This allows to know if the next timeIndex will be
a dumping time. The function object "partialWrite" modifyes the write option
of the those fields which will be written down at given intervals of the overall
outout times.
2013-06-07 10:11:07 +01:00
a07b59c279 STYLE: Updated copyright year 2013-01-21 16:49:49 +00:00
685635e6a3 ENH: Deleting parabolicCylindricalCS, sphericalCS and toroidalCS
coordinate systems
Modifying constructors from dictionary of coordinateSystem class (no
default type)
Adding localAxesRotation type. It constructs a axes-rotation tensor on each
cell centre.
Adding functionality to coordinateRotation blase class (transformTensor,
transformVector, etc)
2013-01-21 12:17:17 +00:00
100a25ee25 STYLE: defineDebug: move into Foam namespace 2012-12-17 17:35:42 +00:00
9d5ce4ae76 ENH: Updated function objects 2012-12-13 10:40:38 +00:00
f3d8e5316c Updated function object documentation 2012-08-13 17:36:58 +01:00
01cf1d6f9e ENH: Updated function object documentation 2012-07-26 13:00:11 +01:00
ea062b8e98 BUG: corrected class to Class for doxy docs 2012-07-23 15:54:21 +01:00
a17b0c75c6 ENH: Updates to function object documentation 2012-07-23 15:23:35 +01:00
a80d4d9b69 ENH: doxygen documentation updates 2012-07-12 17:12:52 +01:00
b15d6af77f STYLE: minor code tweaks 2012-07-12 11:14:18 +01:00
3dd7ab054b STYLE: change of doxygen tags for function objects and ico wall functions boundaryConditions 2012-07-12 10:35:09 +01:00
61eaea8b81 ENH: restructured doxygen entries for function objects 2012-07-11 14:02:11 +01:00
354d0ae7ce ENH: First pass through doxygen info updates for function objects 2012-07-11 12:26:08 +01:00
ac7980d5df STYLE: functionObjectLibs: corrected library names 2011-11-09 16:14:09 +00:00
fdcfe3bda6 ENH: Added fieldCoordinateSystemTransform function object - self explanatory 2011-10-13 13:06:11 +01:00