src/OpenFOAM/fields/Fields/complexFields/complexFields.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 Typedef
  25     Foam::complexField
  26
  27 Description
  28     Specialisation of Field\<T\> for complex.
  29
  30 Typedef
  31     Foam::complexVectorField
  32
  33 Description
  34     Specialisation of Field\<T\> for complexVector.
  35
  36 SourceFiles
  37     complexFields.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef complexFields_H
  42 #define complexFields_H
  43
  44 #include "complex.H"
  45 #include "complexVector.H"
  46 #include "primitiveFields.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  54
  55 typedef Field<complex> complexField;
  56
  57 complexField ComplexField(const UList<scalar>&, const UList<scalar>&);
  58 complexField ReComplexField(const UList<scalar>&);
  59 complexField ImComplexField(const UList<scalar>&);
  60 scalarField Re(const UList<complex>&);
  61 scalarField Im(const UList<complex>&);
  62 scalarField ReImSum(const UList<complex>&);
  63
  64
  65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  66
  67 typedef Field<complexVector> complexVectorField;
  68
  69 complexVectorField ComplexField(const UList<vector>&, const UList<vector>&);
  70 complexVectorField ReComplexField(const UList<vector>&);
  71 complexVectorField ImComplexField(const UList<vector>&);
  72 vectorField Re(const UList<complexVector>&);
  73 vectorField Im(const UList<complexVector>&);
  74 vectorField ReImSum(const UList<complexVector>&);
  75
  76 complexVectorField operator^
  77 (
  78     const UList<vector>&,
  79     const UList<complexVector>&
  80 );
  81
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 } // End namespace Foam
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 #endif
  90
  91 // ************************************************************************* //