leastSquaresStencilOpt.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) 2019 OpenCFD Ltd.
    Copyright (C) 2016-2019 ISP RAS (www.ispras.ru) UniCFD Group (www.unicfd.ru)
-------------------------------------------------------------------------------
License
    This file is part of QGDsolver library, based on 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/>.
Group grpleastSquaresOpt
    This group contains common part of QGD solvers.
Class
    Foam::fvsc::leastSquaresOpt::leastSquaresStencilOpt
Description 
    Methods for optimal calculating of directional derivative. 
    With parallel realisation.
Source Files
    leastSquaresStencilOpt.C
\*---------------------------------------------------------------------------*/

#ifndef leastSquaresOptStencil_H
#define leastSquaresOptStencil_H

#include "fvscStencil.H"
#include "regIOobject.H"
#include "labelList.H"

#include "volFields.H"
#include "surfaceFields.H"
#include "surfaceMesh.H"

#include "fvCFD.H"
#include "zeroGradientFvPatchFields.H"
#include "vector.H"
#include "List.H"
#include "leastSquaresBase.H"

namespace Foam
{

namespace fvsc
{

/*---------------------------------------------------------------------------*\
                    Class leastSquaresOpt Declaration
\*---------------------------------------------------------------------------*/

class leastSquaresOpt
:
    public fvscStencil, public leastSquaresBase
{

protected:

        void faceScalarDer(const Field<scalar>& iF,const Field<scalar>& sF,int com, surfaceScalarField& rField);
        void faceScalarDer(const tmp<Field<scalar>>& tiF,const tmp<Field<scalar>>& tsF, int com, tmp<surfaceScalarField>& trField);
        
        void faceScalarDer
        (
            const List3<scalar>& procVfValues,
            const surfaceScalarField& sF,
            int derComp,
            surfaceScalarField& rField
        );
        
        void faceScalarDer
        (
            const tmp<List3<scalar>>& tprocVfValues,
            const tmp<surfaceScalarField>& tsF,
            int derComp,
            tmp<surfaceScalarField>& trField
        );

        #include "extendedFaceStencilFormVfValues.H"

public:

        TypeName ("leastSquaresOpt");

// Constructors

        //- Construct from IOobject. Optional flag for if IOobject is the
        //  top level regIOobject.
        leastSquaresOpt(const IOobject&);
        
        //- Destructor
        ~leastSquaresOpt();

        tmp<surfaceVectorField> Grad(const volScalarField& iF);
        tmp<surfaceVectorField> Grad(const volScalarField& iF, const surfaceScalarField&);

        tmp<surfaceTensorField> Grad(const volVectorField& iVF);
        tmp<surfaceTensorField> Grad(const volVectorField& iVF, const surfaceVectorField&);

        tmp<surfaceScalarField> Div(const volVectorField& iVF);

        tmp<surfaceVectorField> Div(const volTensorField& iTF);
        
};

} //fvsc

} //Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif