src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::fieldCoordinateSystemTransform
  26
  27 Description
  28     Transforms fields from global cartesian co-ordinates to local co-ordinate
  29     system
  30
  31 SourceFiles
  32     fieldCoordinateSystemTransform.C
  33     IOfieldCoordinateSystemTransform.H
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef fieldCoordinateSystemTransform_H
  38 #define fieldCoordinateSystemTransform_H
  39
  40 #include "OFstream.H"
  41 #include "pointFieldFwd.H"
  42 #include "volFields.H"
  43 #include "surfaceFields.H"
  44 #include "coordinateSystem.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 // Forward declaration of classes
  52 class objectRegistry;
  53 class dictionary;
  54 class mapPolyMesh;
  55
  56 /*---------------------------------------------------------------------------*\
  57                Class fieldCoordinateSystemTransform Declaration
  58 \*---------------------------------------------------------------------------*/
  59
  60 class fieldCoordinateSystemTransform
  61 {
  62 protected:
  63
  64     // Protected data
  65
  66         //- Name
  67         word name_;
  68
  69         const objectRegistry& obr_;
  70
  71         //- on/off switch
  72         bool active_;
  73
  74         //- Fields to transform
  75         wordList fieldSet_;
  76
  77         //- Co-ordinate system to transform to
  78         coordinateSystem coordSys_;
  79
  80
  81     // Protected Member Functions
  82
  83         //- Disallow default bitwise copy construct
  84         fieldCoordinateSystemTransform(const fieldCoordinateSystemTransform&);
  85
  86         //- Disallow default bitwise assignment
  87         void operator=(const fieldCoordinateSystemTransform&);
  88
  89         template<class Type>
  90         void transform(const word& fieldName) const;
  91
  92         template<class Type>
  93         void transformField(const Type& field) const;
  94
  95
  96 public:
  97
  98     //- Runtime type information
  99     TypeName("fieldCoordinateSystemTransform");
 100
 101
 102     // Constructors
 103
 104         //- Construct for given objectRegistry and dictionary.
 105         //  Allow the possibility to load fields from files
 106         fieldCoordinateSystemTransform
 107         (
 108             const word& name,
 109             const objectRegistry&,
 110             const dictionary&,
 111             const bool loadFromFiles = false
 112         );
 113
 114
 115     //- Destructor
 116     virtual ~fieldCoordinateSystemTransform();
 117
 118
 119     // Member Functions
 120
 121         //- Return name of the fieldCoordinateSystemTransform object
 122         virtual const word& name() const
 123         {
 124             return name_;
 125         }
 126
 127         //- Read the input data
 128         virtual void read(const dictionary&);
 129
 130         //- Execute, currently does nothing
 131         virtual void execute();
 132
 133         //- Execute at the final time-loop, currently does nothing
 134         virtual void end();
 135
 136         //- Write
 137         virtual void write();
 138
 139         //- Update for changes of mesh
 140         virtual void updateMesh(const mapPolyMesh&)
 141         {}
 142
 143         //- Update for changes of mesh
 144         virtual void movePoints(const pointField&)
 145         {}
 146 };
 147
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 } // End namespace Foam
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 #ifdef NoRepository
 156 #   include "fieldCoordinateSystemTransformTemplates.C"
 157 #endif
 158
 159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 160
 161 #endif
 162
 163 // ************************************************************************* //