No description
Find a file
Henry Weller e22c65dd8e Standardized the selection of required and optional fields in BCs, fvOptions, functionObjects etc.
In most boundary conditions, fvOptions etc. required and optional fields
to be looked-up from the objectRegistry are selected by setting the
keyword corresponding to the standard field name in the BC etc. to the
appropriate name in the objectRegistry.  Usually a default is provided
with sets the field name to the keyword name, e.g. in the
totalPressureFvPatchScalarField the velocity is selected by setting the
keyword 'U' to the appropriate name which defaults to 'U':

        Property     | Description             | Required    | Default value
        U            | velocity field name     | no          | U
        phi          | flux field name         | no          | phi
        .
        .
        .

However, in some BCs and functionObjects and many fvOptions another
convention is used in which the field name keyword is appended by 'Name'
e.g.

        Property     | Description             | Required    | Default value
        pName        | pressure field name     | no          | p
        UName        | velocity field name     | no          | U

This difference in convention is unnecessary and confusing, hinders code
and dictionary reuse and complicates code maintenance.  In this commit
the appended 'Name' is removed from the field selection keywords
standardizing OpenFOAM on the first convention above.
2016-05-21 20:28:20 +01:00
applications Standardized the selection of required and optional fields in BCs, fvOptions, functionObjects etc. 2016-05-21 20:28:20 +01:00
bin etc/codeTemplates/functionObject: Updated to correspond to the new functionObject structure 2016-05-15 21:47:18 +01:00
doc Further standardization of loop index naming: pointI -> pointi, patchI -> patchi 2016-05-18 21:20:42 +01:00
etc dynamicCode: Renamed 'redirectType' to 'name' to clarify the purpose 2016-05-18 23:10:42 +01:00
src Standardized the selection of required and optional fields in BCs, fvOptions, functionObjects etc. 2016-05-21 20:28:20 +01:00
tutorials Standardized the selection of required and optional fields in BCs, fvOptions, functionObjects etc. 2016-05-21 20:28:20 +01:00
wmake wrmdep: Now prints the full path of the .dep files removed 2016-05-21 17:19:07 +01:00
.gitignore tutorials/combustion/fireFoam/les: Added missing ph_rgh.orig files 2016-04-27 16:18:25 +01:00
Allwmake scripts: Reformat with consistent section separators 2016-02-15 18:30:24 +00:00
COPYING Add licence and README 2014-12-10 15:50:51 +00:00
README.org README.org: Added link to the OpenFOAM C++ Style Guide 2016-04-20 18:23:59 +01:00

README for OpenFOAM-dev

#

About OpenFOAM

OpenFOAM is a free, open source computational fluid dynamics (CFD) software package released by the OpenFOAM Foundation. It has a large user base across most areas of engineering and science, from both commercial and academic organisations. OpenFOAM has an extensive range of features to solve anything from complex fluid flows involving chemical reactions, turbulence and heat transfer, to solid dynamics and electromagnetics.

Copyright

OpenFOAM is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See the file COPYING in this directory or http://www.gnu.org/licenses/, for a description of the GNU General Public License terms under which you can copy the files.