/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2013-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/>.

Class
    Foam::smoothAlignmentSolver

Description

SourceFiles
    smoothAlignmentSolverI.H
    smoothAlignmentSolver.C
    smoothAlignmentSolverIO.C

\*---------------------------------------------------------------------------*/

#ifndef smoothAlignmentSolver_H
#define smoothAlignmentSolver_H

#include "cellShapeControlMesh.H"
#include "triadField.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                   Class smoothAlignmentSolver Declaration
\*---------------------------------------------------------------------------*/

class smoothAlignmentSolver
{
    // Private data

        cellShapeControlMesh& mesh_;


    // Private Member Functions

        template<class Triangulation, class Type>
        tmp<Field<Type>> filterFarPoints
        (
            const Triangulation& mesh,
            const Field<Type>& field
        );

        template<class Triangulation>
        autoPtr<mapDistribute> buildMap
        (
            const Triangulation& mesh,
            labelListList& pointPoints
        );

        template<class Triangulation>
        autoPtr<mapDistribute> buildReferredMap
        (
            const Triangulation& mesh,
            labelList& indices
        );

        template<class Triangulation>
        tmp<triadField> buildAlignmentField(const Triangulation& mesh);

        template<class Triangulation>
        tmp<pointField> buildPointField(const Triangulation& mesh);

        //- Apply the fixed alignments to the triad
        void applyBoundaryConditions
        (
            const triad& fixedAlignment,
            triad& t
        ) const;

        //- Disallow default bitwise copy construct
        smoothAlignmentSolver(const smoothAlignmentSolver&);

        //- Disallow default bitwise assignment
        void operator=(const smoothAlignmentSolver&);


public:

    // Constructors

        //- Construct null
        smoothAlignmentSolver(cellShapeControlMesh& mesh);


    //- Destructor
    ~smoothAlignmentSolver();


    // Member Functions

        // Edit

            //- Smooth the alignments on the mesh
            void smoothAlignments(const label maxSmoothingIterations);
};


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

} // End namespace Foam

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

#endif

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