nonOrthogonalSolutionControl.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2018-2022 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/>.
 
Class
    Foam::nonOrthogonalSolutionControl
 
Description
    Non-orthogonal solution control class. Provides non-orthogonal-loop control
    methods.
 
SourceFiles
    nonOrthogonalControlI.H
    nonOrthogonalSolutionControl.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef nonOrthogonalSolutionControl_H
#define nonOrthogonalSolutionControl_H
 
#include "singleRegionSolutionControl.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                Class nonOrthogonalSolutionControl Declaration
\*---------------------------------------------------------------------------*/
 
class nonOrthogonalSolutionControl
:
    public singleRegionSolutionControl
{
protected:
 
    // Protected data
 
        //- Maximum number of non-orthogonal correctors
        label nCorrNonOrth_;
 
        //- Current non-orthogonal corrector index
        label corrNonOrth_;
 
 
public:
 
    // Static Data Members
 
        //- Run-time type information
        TypeName("nonOrthogonalSolutionControl");
 
 
    // Constructors
 
        //- Construct from a mesh and the name of the algorithm
        nonOrthogonalSolutionControl(fvMesh& mesh, const word& algorithmName);
 
 
    //- Destructor
    virtual ~nonOrthogonalSolutionControl();
 
 
    // Member Functions
 
        // IO
 
            //- Read controls
            virtual bool read();
 
 
        // Access
 
            //- Maximum number of non-orthogonal correctors
            inline label nCorrNonOrth() const;
 
            //- Flag to indicate any non-orthogonal iteration
            inline bool anyNonOrthogonalIter() const;
 
            //- Flag to indicate the first non-orthogonal iteration
            inline bool firstNonOrthogonalIter() const;
 
            //- Flag to indicate the last non-orthogonal iteration
            inline bool finalNonOrthogonalIter() const;
 
            //- Flag to indicate whether in final state
            bool isFinal(const bool finalIter) const;
 
 
        // Evolution
 
            //- Non-orthogonal corrector loop
            bool correctNonOrthogonal(const bool finalIter = false);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "nonOrthogonalSolutionControlI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //