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: add UList typedefs for the various List counterparts

Browse Source 
- eg,
    labelUList  <-> labelList
    scalarUList <-> scalarList
    ...

Note the unallocLabelList typedef is still available.
However labelUList requires less typing (10 vs. 17 chars) and has a
more obvious to labelList.
This commit is contained in:
Mark Olesen
2010-10-13 10:43:16 +02:00
parent ee0cb57cd9
commit 850fa066d3
17 changed files with 119 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/doxygen/Doxyfile
View File

@ -579,7 +579,9 @@ WARN_LOGFILE =
# $(WM_PROJECT_DIR)/applications/solvers
# limit input for testing purposes
INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global
INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global \
$(WM_PROJECT_DIR)/src/OpenFOAM/containers \
$(WM_PROJECT_DIR)/src/OpenFOAM/primitives
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

6
src/OpenFOAM/containers/Lists/PackedList/PackedBoolList.H
View File

@ -51,6 +51,12 @@ SeeAlso
namespace Foam
{
// Forward declaration
class PackedBoolList;
//- @typedef A List of PackedBoolList
typedef List<PackedBoolList> PackedBoolListList;
/*---------------------------------------------------------------------------*\
Class PackedBoolList Declaration
\*---------------------------------------------------------------------------*/

1
src/OpenFOAM/containers/Lists/UList/UList.H
View File

@ -59,6 +59,7 @@ template<class T> class SubList;
template<class T> class UList;
template<class T> Ostream& operator<<(Ostream&, const UList<T>&);
typedef UList<label> labelUList;
/*---------------------------------------------------------------------------*\
Class UList Declaration

8
src/OpenFOAM/primitives/Lists/boolList.H
View File

@ -21,6 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::boolUList
Description
A UList of bool
Typedef
Foam::boolList
@ -39,6 +45,8 @@ Description
namespace Foam
{
typedef UList<bool> boolUList;
typedef List<bool> boolList;
typedef List<List<bool> > boolListList;
}

10
src/OpenFOAM/primitives/Lists/fileNameList.H
View File

@ -21,11 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::fileNameUList
Description
A UList of fileNames.
Typedef
Foam::fileNameList
Description
List of fileNames.
A List of fileNames.
\*---------------------------------------------------------------------------*/
@ -39,6 +45,8 @@ Description
namespace Foam
{
typedef UList<fileName> fileNameUList;
typedef List<fileName> fileNameList;
}

18
src/OpenFOAM/primitives/Lists/labelList.H
View File

@ -25,7 +25,19 @@ Typedef
Foam::labelList
Description
Label container classes
A List of labels
Typedef
Foam::labelListList
Description
A List of labelList
Typedef
Foam::labelListListList
Description
A List of labelListList
\*---------------------------------------------------------------------------*/
@ -39,11 +51,11 @@ Description
namespace Foam
{
// Note: frequently used UList version is located in container itself
typedef List<label> labelList;
typedef List<labelList> labelListList;
typedef List<labelListList> labelListListList;
typedef UList<label> unallocLabelList;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

10
src/OpenFOAM/primitives/Lists/scalarList.H
View File

@ -21,11 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::scalarUList
Description
A UList of scalars.
Typedef
Foam::scalarList
Description
List of scalars.
A List of scalars.
\*---------------------------------------------------------------------------*/
@ -39,6 +45,8 @@ Description
namespace Foam
{
typedef UList<scalar> scalarUList;
typedef List<scalar> scalarList;
typedef List<scalarList> scalarListList;
}

10
src/OpenFOAM/primitives/Lists/sphericalTensorList.H
View File

@ -21,11 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::sphericalTensorUList
Description
A UList of sphericalTensors.
Typedef
Foam::sphericalTensorList
Description
List of sphericalTensors.
A List of sphericalTensors.
\*---------------------------------------------------------------------------*/
@ -39,6 +45,8 @@ Description
namespace Foam
{
typedef UList<sphericalTensor> sphericalTensorUList;
typedef List<sphericalTensor> sphericalTensorList;
}

10
src/OpenFOAM/primitives/Lists/stringList.H
View File

@ -21,11 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::stringUList
Description
A UList of strings.
Typedef
Foam::stringList
Description
List of strings.
A List of strings.
\*---------------------------------------------------------------------------*/
@ -39,6 +45,8 @@ Description
namespace Foam
{
typedef UList<string> stringUList;
typedef List<string> stringList;
}

10
src/OpenFOAM/primitives/Lists/symmTensorList.H
View File

@ -21,11 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::symmTensorUList
Description
A UList of symmTensors.
Typedef
Foam::symmTensorList
Description
List of symmTensors.
A List of symmTensors.
\*---------------------------------------------------------------------------*/
@ -39,6 +45,8 @@ Description
namespace Foam
{
typedef UList<symmTensor> symmTensorUList;
typedef List<symmTensor> symmTensorList;
}

10
src/OpenFOAM/primitives/Lists/tensorList.H
View File

@ -21,11 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::tensorUList
Description
A UList of tensors.
Typedef
Foam::tensorList
Description
List of tensors.
A List of tensors.
\*---------------------------------------------------------------------------*/
@ -39,6 +45,8 @@ Description
namespace Foam
{
typedef UList<tensor> tensorUList;
typedef List<tensor> tensorList;
}

10
src/OpenFOAM/primitives/Lists/vectorList.H
View File

@ -21,11 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::vectorUList
Description
A UList of vectors.
Typedef
Foam::vectorList
Description
List of vectors.
A List of vectors.
\*---------------------------------------------------------------------------*/
@ -39,6 +45,8 @@ Description
namespace Foam
{
typedef UList<vector> vectorUList;
typedef List<vector> vectorList;
}

10
src/OpenFOAM/primitives/Lists/wordList.H
View File

@ -21,11 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::wordUList
Description
A UList of words.
Typedef
Foam::wordList
Description
List of words.
A List of words.
\*---------------------------------------------------------------------------*/
@ -39,6 +45,8 @@ Description
namespace Foam
{
typedef UList<word> wordUList;
typedef List<word> wordList;
}

12
src/OpenFOAM/primitives/Lists/wordReList.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -21,11 +21,17 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::wordReUList
Description
A UList of wordRe (word or regular expression)
Typedef
Foam::wordReList
Description
List of wordRe (word or regular expression)
A List of wordRe (word or regular expression)
\*---------------------------------------------------------------------------*/
@ -39,6 +45,8 @@ Description
namespace Foam
{
typedef UList<wordRe> wordReUList;
typedef List<wordRe> wordReList;
}

2
src/OpenFOAM/primitives/strings/wordRe/wordRe.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License

2
src/OpenFOAM/primitives/strings/wordRe/wordRe.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License

2
src/OpenFOAM/primitives/strings/wordRe/wordReI.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License