Skip to content
Snippets Groups Projects
RectangularMatrix.H 3.51 KiB
Newer Older
  • Learn to ignore specific revisions
  • /*---------------------------------------------------------------------------*\
      =========                 |
      \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
       \\    /   O peration     |
    
        \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
    
         \\/     M anipulation  |
    -------------------------------------------------------------------------------
    License
        This file is part of OpenFOAM.
    
    
        OpenFOAM is free software: you can redistribute it and/or modify it
        under the terms of the GNU General Public License as published by
        the Free Software Foundation, either version 3 of the License, or
        (at your option) any later version.
    
    
        OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
        ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
        FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
        for more details.
    
        You should have received a copy of the GNU General Public License
    
        along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
    
        A templated 2D rectangular m x n matrix of objects of \<Type\>.
    
        The matrix dimensions are used for subscript bounds checking etc.
    
        RectangularMatrixI.H
        RectangularMatrix.C
    
    
    \*---------------------------------------------------------------------------*/
    
    
    #ifndef RectangularMatrix_H
    #define RectangularMatrix_H
    
    
    #include "Matrix.H"
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    namespace Foam
    {
    
    /*---------------------------------------------------------------------------*\
    
    \*---------------------------------------------------------------------------*/
    
    
    template<class Type>
    class RectangularMatrix
    :
        public Matrix<RectangularMatrix<Type>, Type>
    
            //- Null constructor.
            inline RectangularMatrix();
    
            //- Construct given number of rows and columns,
            inline RectangularMatrix(const label m, const label n);
    
            //- Construct from a block of another matrix
            inline RectangularMatrix(const typename RectangularMatrix::Block&);
    
            //- Construct with given number of rows and columns
            //  initializing all elements to zero
            inline RectangularMatrix(const label m, const label n, const zero);
    
            //- Construct given number of rows/columns
            //  Initializing to the identity matrix
            inline RectangularMatrix(const label n, const Identity<Type>);
    
    
            //- Construct with given number of rows and columns
            //  and value for all elements.
            inline RectangularMatrix(const label m, const label n, const Type&);
    
            //- Construct from Istream.
            inline RectangularMatrix(Istream&);
    
            inline autoPtr<RectangularMatrix<Type>> clone() const;
    
    
    
        // Member operators
    
            //- Assignment of all entries to zero
            void operator=(const zero);
    
    // Global functions and operators
    
    template<class Type>
    RectangularMatrix<Type> outer(const Field<Type>& f1, const Field<Type>& f2);
    
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    } // End namespace Foam
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    
    #include "RectangularMatrixI.H"
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    #endif
    
    // ************************************************************************* //