/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 1991-2015 OpenCFD Ltd.
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file uses OpenFOAM and is provided as free software without any warranty

    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 2 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, write to the Free Software Foundation,
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Class
    totalPressureCorrectorCompFvPatchScalarField

Description

BC for pressure corrector under total conditions: automatic

SourceFiles

    totalPressureCorrectorCompFvPatchScalarField.C

Authors
    Luca Mangani   HSLU email: luca.mangani@hslu.ch
    Marwan Darwish AUB  email: darwish@aub.edu.lb
    Fadl Moukalled AUB  email: moukalled@aub.edu.lb
\*---------------------------------------------------------------------------*/

#ifndef totalPressureCorrectorCompFvPatchScalarField_H
#define totalPressureCorrectorCompFvPatchScalarField_H

#include "fixedValueFvPatchFields.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                           Class wallTemperatureFvPatch Declaration
\*---------------------------------------------------------------------------*/

class totalPressureCorrectorCompFvPatchScalarField
:
    public fixedValueFvPatchScalarField
{

    scalarField p0_;

public:

    //- Runtime type information
    TypeName("totalPressureCorrectorComp");


    // Constructors

        //- Construct from patch and internal field
        totalPressureCorrectorCompFvPatchScalarField
        (
            const fvPatch&,
            const DimensionedField<scalar,volMesh>&
        );

        //- Construct from patch, internal field and dictionary
        totalPressureCorrectorCompFvPatchScalarField
        (
            const fvPatch&,
            const DimensionedField<scalar,volMesh>&,
            const dictionary&
        );

        //- Construct by mapping given wallTemperatureFvPatchScalarField 
        //  onto a new patch
        totalPressureCorrectorCompFvPatchScalarField
        (
            const totalPressureCorrectorCompFvPatchScalarField&,
            const fvPatch&,
            const DimensionedField<scalar,volMesh>&,
            const fvPatchFieldMapper&
        );

        //- Construct as copy
        totalPressureCorrectorCompFvPatchScalarField
        (
            const totalPressureCorrectorCompFvPatchScalarField&
        );

        //- Construct and return a clone
        virtual tmp<fvPatchScalarField> clone() const
        {
            return tmp<fvPatchScalarField>
            (
                new totalPressureCorrectorCompFvPatchScalarField(*this)
            );
        }

        //- Construct as copy setting internal field reference
        totalPressureCorrectorCompFvPatchScalarField
        (
            const totalPressureCorrectorCompFvPatchScalarField&,
            const DimensionedField<scalar,volMesh>&
        );

        //- Construct and return a clone setting internal field reference
        virtual tmp<fvPatchScalarField> clone
        (
            const DimensionedField<scalar,volMesh>& iF
        ) const
        {
            return tmp<fvPatchScalarField>
            (
                new totalPressureCorrectorCompFvPatchScalarField(*this, iF)
            );
        }

        //- Map (and resize as needed) from self given a mapping object
        virtual void autoMap
        (
            const fvPatchFieldMapper&
        );

        //- Reverse map the given fvPatchField onto this fvPatchField
        virtual void rmap
        (
            const fvPatchScalarField&,
            const labelList&
        );

       //- Update the coefficients associated with the patch field
        virtual void updateCoeffs();
				
        virtual tmp< Field< scalar > > gradientBoundaryCoeffs () const;

        virtual tmp<Field<scalar> > gradientInternalCoeffs() const;
						
        virtual tmp< Field< scalar > > valueInternalCoeffs (const tmp< scalarField > &) const;

        virtual tmp< Field< scalar > > valueBoundaryCoeffs (const tmp< scalarField > &) const;


        Field<scalar>  deltaM() const;

        Field<scalar>  Cu() const;

        // Mapping functions
        const Field<scalar>& p0() const
        {
	        return p0_;
	    }

        Field<scalar>& p0()
	    {
	 	    return p0_;
	    }

        //- Write
        virtual void write(Ostream&) const;
};


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

} // End namespace Foam

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

#endif

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