src/sampling/sampledSet/coordSet/coordSet.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 Class
  26     Foam::coordSet
  27
  28 Description
  29     Holds list of sampling positions
  30
  31 SourceFiles
  32     coordSet.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef coordSet_H
  37 #define coordSet_H
  38
  39 #include <OpenFOAM/pointField.H>
  40 #include <OpenFOAM/word.H>
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class coordSet Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class coordSet
  52 :
  53     public pointField
  54 {
  55
  56 protected:
  57
  58         //- Name
  59         const word name_;
  60
  61         //- Axis write type
  62         const word axis_;
  63
  64         //- Reference point for "distance" write specifier.
  65         point refPoint_;
  66
  67 public:
  68
  69     // Constructors
  70
  71         //- Construct from components
  72         coordSet
  73         (
  74             const word& name,
  75             const word& axis
  76         );
  77
  78
  79         //- Construct from components
  80         coordSet
  81         (
  82             const word& name,
  83             const word& axis,
  84             const List<point>& points,
  85             const point& refPoint = point::zero
  86         );
  87
  88         //- Construct from components
  89         coordSet
  90         (
  91             const word& name,
  92             const word& axis,
  93             const scalarField& points,
  94             const scalar refPoint = 0.0
  95         );
  96
  97
  98     // Member functions
  99
 100         const word& name() const
 101         {
 102             return name_;
 103         }
 104
 105         const word& axis() const
 106         {
 107             return axis_;
 108         }
 109
 110         const point& refPoint() const
 111         {
 112             return refPoint_;
 113         }
 114
 115         //- Is axis specification a vector
 116         bool hasVectorAxis() const;
 117
 118         //- Get coordinate of point according to axis specification.
 119         //  If axis="distance" can be: -distance to starting point (e.g.
 120         //  uniformSet) or -distance to first sampling point
 121         //  (e.g. cloudSet)
 122         scalar scalarCoord
 123         (
 124             const label index
 125         ) const;
 126
 127         //- Get point according to axis="full" specification
 128         vector vectorCoord
 129         (
 130             const label index
 131         ) const;
 132
 133         Ostream& write(Ostream& os) const;
 134 };
 135
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 } // End namespace Foam
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 #endif
 144
 145 // ************************ vim: set sw=4 sts=4 et: ************************ //