src/equationReader/equationSource/equationSource.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::equationSource
  26
  27 Description
  28     A set of data sources for the equationReader templated by Type.
  29
  30 SourceFiles
  31     equationSourceI.H
  32     equationSource.C
  33     equationSourceTemplates.C
  34
  35 Author
  36     David L. F. Gaden
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef equationSource_H
  41 #define equationSource_H
  42
  43 #include "word.H"
  44 #include "UPtrList.H"
  45 #include "wordList.H"
  46 #include "PtrList.H"
  47 #include "GeometricFields.H"
  48
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54
  55 /*---------------------------------------------------------------------------*\
  56                         Class equationSource Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 template <class Type>
  60 class equationSource
  61 {
  62
  63     // Private data
  64
  65         //- Name of templated type
  66         word templateTypeName_;
  67
  68         //- Individual "Type"s as sources
  69         UPtrList<const Type> singles_;
  70
  71         //- Names associated with singles_
  72         wordList singleNames_;
  73
  74         //- Dimensions associated with singles_
  75         PtrList<dimensionSet> singleDimensions_;
  76
  77         //- Fields of Type - holds the source data for regular
  78         //  Field<Type>'s, but also can hold source data for GeometricFields
  79         //      fields_[sourceIndex][geoIndex][cellIndex]
  80         //  Where:
  81         //      sourceIndex is the source variable index
  82         //      geoIndex is to accommodate GeometricFields:
  83         //          0 = internalField (or standard Field<Type>)
  84         //          1+ = boundary patch as a Field<Type>
  85         //      cellIndex is the index number of the Field<Type>
  86         PtrList<UPtrList<const Field<Type> > > fields_;
  87
  88         //- Dimensions associated with the fields_
  89         PtrList<dimensionSet> fieldDimensions_;
  90
  91         //- Names associated with the fields_
  92         wordList fieldNames_;
  93
  94 public:
  95
  96     // Static data members
  97
  98         static const char* const typeName;
  99
 100
 101     // Constructors
 102
 103         //- Construct from components
 104         explicit equationSource
 105         (
 106             const word& templateTypeName
 107         );
 108
 109     // Destructor
 110     ~equationSource();
 111
 112     // Member functions
 113
 114         // Access
 115
 116             //- Individual "Type"s as sources
 117             inline const UPtrList<const Type>& singles() const;
 118
 119             //- Names associated with singles
 120             inline const wordList& singleNames() const;
 121
 122             //- Dimensions associated with singles_
 123             inline const PtrList<dimensionSet>& singleDimensions() const;
 124
 125             //- Fields of Type - holds the source data for regular
 126             inline const PtrList<UPtrList<const Field<Type> > >&
 127                 fields() const;
 128
 129             //- Dimensions associated with the fields_
 130             inline const PtrList<dimensionSet>& fieldDimensions() const;
 131
 132             //- Names associated with the fields_
 133             inline const wordList& fieldNames() const;
 134
 135         // Data lookup
 136
 137             //- True if lookupName is a valid single source
 138             bool foundSingle(const word& lookupName) const;
 139
 140             //- True if lookupName is a valid field source
 141             bool foundField(const word& lookupName) const;
 142
 143             //- Returns single sourceIndex for lookupName - fails if not found
 144             label lookupSingle(const word& lookupName) const;
 145
 146             //- Returns field sourceIndex for lookupName - fails if not found
 147             label lookupField(const word& lookupName) const;
 148
 149             //- Returns the number of fields associated with sourceIndex
 150             label geoSize(label sourceIndex) const;
 151
 152             //- Returns the field size associated with source and geo indices
 153             label fieldSize
 154             (
 155                 label sourceIndex,
 156                 label geoIndex
 157             ) const;
 158
 159             //- Return componentIndex for a given component name
 160             //  Returns -1 if not found (error handled by calling function)
 161             label lookupComponentIndex(const word& componentName) const;
 162
 163             //- Returns the number of singles_
 164             label nSingles() const;
 165
 166             //- Returns the number of fields_
 167             label nFields() const;
 168
 169         // Data retrieval
 170
 171             //- Retrieve scalar value from singles
 172             const scalar& singleValue
 173             (
 174                 label sourceIndex,
 175                 label componentIndex
 176             ) const;
 177
 178             //- Retrieve dimensions from singles
 179             const dimensionSet& singleDimensions(label sourceIndex) const;
 180
 181             //- Retrieve name associated with singles
 182             const word& singleName(label sourceIndex) const;
 183
 184             //- Retrieve scalar value from field
 185             const scalar& fieldValue
 186             (
 187                 label sourceIndex,
 188                 label componentIndex,
 189                 label cellIndex,
 190                 label geoIndex
 191             ) const;
 192
 193             //- Retrieve component as entire field
 194             void fullFieldValue
 195             (
 196                 scalarField& result,
 197                 label sourceIndex,
 198                 label componentIndex,
 199                 label geoIndex
 200             ) const;
 201
 202             //- Retrieve dimensions from field
 203             const dimensionSet& fieldDimensions(label sourceIndex) const;
 204
 205             //- Retrieve name associated with field
 206             const word& fieldName(label sourceIndex) const;
 207
 208         // Adding data sources
 209
 210             //- Add single source
 211             void addSource
 212             (
 213                 const Type& singleIn,
 214                 const word& name,
 215                 dimensionSet dimensions = dimless
 216             );
 217
 218             //- Add dimensionedSingle source
 219             void addSource
 220             (
 221                 const dimensioned<Type>& dSingleIn
 222             );
 223
 224             //- Add field source
 225             void addSource
 226             (
 227                 const Field<Type>& fieldIn,
 228                 const word& name,
 229                 dimensionSet dimensions = dimless
 230             );
 231
 232             //- Add dimensioned field source
 233             template<class GeoMesh>
 234             void addSource
 235             (
 236                 const DimensionedField<Type, GeoMesh>& dFieldIn
 237             );
 238
 239             //- Add geometric field source
 240             template<template<class> class PatchField, class GeoMesh>
 241             void addSource
 242             (
 243                 const GeometricField<Type, PatchField, GeoMesh>& gFieldIn
 244             );
 245
 246         // Removing data sources
 247
 248             //- Remove a single source and reorder index
 249             void removeSingle(label sourceIndex);
 250
 251             //- Remove a field source and reorderd index
 252             void removeField(label sourceIndex);
 253
 254         // Input / output
 255
 256             //- Output sources to a dictionary
 257             dictionary outputDictionary() const;
 258 };
 259
 260 template<>
 261 label equationSource<scalar>::lookupComponentIndex
 262 (
 263     const word& componentName
 264 ) const;
 265
 266 template<>
 267 const scalar& equationSource<scalar>::singleValue
 268 (
 269     label sourceIndex,
 270     label componentIndex
 271 ) const;
 272
 273 template<>
 274 const scalar& equationSource<scalar>::fieldValue
 275 (
 276     label sourceIndex,
 277     label componentIndex,
 278     label cellIndex,
 279     label geoIndex
 280 ) const;
 281
 282 template<>
 283 void equationSource<scalar>::fullFieldValue
 284 (
 285     scalarField& result,
 286     label sourceIndex,
 287     label componentIndex,
 288     label geoIndex
 289 ) const;
 290
 291
 292 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 293
 294 } // End namespace Foam
 295
 296 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 297
 298 #include "equationSourceI.H"
 299 #ifdef NoRepository
 300 #   include "equationSource.C"
 301 //#   include "equationScalarSource.C"
 302 #endif
 303
 304 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 305
 306 #endif
 307
 308 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //