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) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Typedef
  26     Foam::complexField
  27
  28 Description
  29     Specialisation of Field\<T\> for complex.
  30
  31 Typedef
  32     Foam::complexVectorField
  33
  34 Description
  35     Specialisation of Field\<T\> for complexVector.
  36
  37 SourceFiles
  38     complexFields.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef complexFields_H
  43 #define complexFields_H
  44
  45 #include "complex.H"
  46 #include "complexVector.H"
  47 #include "primitiveFields.H"
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 namespace Foam
  52 {
  53
  54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  55
  56 typedef Field<complex> complexField;
  57
  58 complexField ComplexField(const UList<scalar>&, const UList<scalar>&);
  59 complexField ReComplexField(const UList<scalar>&);
  60 complexField ImComplexField(const UList<scalar>&);
  61 scalarField Re(const UList<complex>&);
  62 scalarField Im(const UList<complex>&);
  63 scalarField ReImSum(const UList<complex>&);
  64
  65
  66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  67
  68 typedef Field<complexVector> complexVectorField;
  69
  70 complexVectorField ComplexField(const UList<vector>&, const UList<vector>&);
  71 complexVectorField ReComplexField(const UList<vector>&);
  72 complexVectorField ImComplexField(const UList<vector>&);
  73 vectorField Re(const UList<complexVector>&);
  74 vectorField Im(const UList<complexVector>&);
  75 vectorField ReImSum(const UList<complexVector>&);
  76
  77 complexVectorField operator^
  78 (
  79     const UList<vector>&,
  80     const UList<complexVector>&
  81 );
  82
  83
  84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  85
  86 } // End namespace Foam
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 #endif
  91
  92 // ************************************************************************* //