forceSuSp.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2016 OpenFOAM Foundation
    Copyright (C) 2020 OpenCFD Ltd.
-------------------------------------------------------------------------------
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/>.
 
Class
    Foam::forceSuSp
 
Description
    Helper container for force Su and Sp terms.
 
        F = Sp(U - Up) + Su
 
    Explicit contribution, Su specified as a force
    Implicit coefficient, Sp specified as force/velocity
 
SourceFiles
    forceSuSpI.H
 
\*---------------------------------------------------------------------------*/
 
#ifndef forceSuSp_H
#define forceSuSp_H
 
#include "Tuple2.H"
#include "vector.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward Declarations
class forceSuSp;
 
inline forceSuSp operator+(const forceSuSp& susp1, const forceSuSp& susp2);
inline forceSuSp operator*(const scalar s, const forceSuSp& susp);
 
 
/*---------------------------------------------------------------------------*\
                          Class forceSuSp Declaration
\*---------------------------------------------------------------------------*/
 
class forceSuSp
:
    public Tuple2<vector, scalar>
{
public:
 
    // Constructors
 
        //- Default construct
        forceSuSp() = default;
 
        //- Construct zero-initialized content
        inline forceSuSp(const Foam::zero);
 
        //- Construct given Tuple2
        inline forceSuSp(const Tuple2<vector, scalar>& susp);
 
        //- Construct given two components
        inline forceSuSp(const vector& Su, const scalar Sp);
 
        //- Construct from Istream
        inline explicit forceSuSp(Istream& is);
 
 
    // Member Functions
 
        // Access
 
            //- Return const access to the explicit contribution [kg.m/s2]
            inline const vector& Su() const;
 
            //- Return const access to the implicit coefficient [kg/s]
            inline scalar Sp() const;
 
 
        // Edit
 
            //- Return reference to the explicit contribution
            inline vector& Su();
 
            //- Return reference to the implicit coefficient
            inline scalar& Sp();
 
 
        // Operators
 
            //- Addition
            inline void operator+=(const forceSuSp& susp);
 
            //- Subtraction
            inline void operator-=(const forceSuSp& susp);
 
 
        // Friend Operators
 
            //- Addition
            friend inline forceSuSp operator*
            (
                const forceSuSp& susp1,
                const forceSuSp& susp2
            );
 
            //- Multiplication
            friend inline forceSuSp operator*
            (
                const scalar s,
                const forceSuSp& susp
            );
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "forceSuSpI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //