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

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

#include "prismMatcher.H"
#include "primitiveMesh.H"
#include "ListOps.H"

// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //

const Foam::label Foam::prismMatcher::vertPerCell = 6;
const Foam::label Foam::prismMatcher::facePerCell = 5;
const Foam::label Foam::prismMatcher::maxVertPerFace = 4;


// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

Foam::prismMatcher::prismMatcher()
:
    cellMatcher
    (
        vertPerCell,
        facePerCell,
        maxVertPerFace,
        "prism"
    )
{}

// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

Foam::prismMatcher::~prismMatcher()
{}

// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //

bool Foam::prismMatcher::matchShape
(
    const bool checkOnly,
    const faceList& faces,
    const labelList& owner,
    const label celli,
    const labelList& myFaces
)
{
    if (!faceSizeMatch(faces, myFaces))
    {
        return false;
    }

    // Calculate localFaces_ and mapping pointMap_, faceMap_
    label numVert = calcLocalFaces(faces, myFaces);

    if (numVert != vertPerCell)
    {
        return false;
    }

    // Set up 'edge' to face mapping.
    calcEdgeAddressing(numVert);

    // Set up point on face to index-in-face mapping
    calcPointFaceIndex();

    // Storage for maps -vertex to mesh and -face to mesh
    vertLabels_.setSize(vertPerCell);
    faceLabels_.setSize(facePerCell);

    //
    // Try first triangular face.
    // Only need to try one orientation of this face since prism is
    // rotation symmetric
    //

    label face0I = -1;
    forAll(faceSize_, facei)
    {
        if (faceSize_[facei] == 3)
        {
            face0I = facei;
            break;
        }
    }

    const face& face0 = localFaces_[face0I];
    label face0vert0 = 0;

    //
    // Try to follow prespecified path on faces of cell,
    // starting at face0vert0
    //

    vertLabels_[0] = pointMap_[face0[face0vert0]];
    faceLabels_[0] = faceMap_[face0I];
    // Info<< endl << "Prism vertex 0: vertex " <<  face0[face0vert0]
    //    << " at position " << face0vert0 << " in face " << face0
    //    << endl;

    // Walk face 0 from vertex 0 to 1
    label face0vert1 =
        nextVert
        (
            face0vert0,
            faceSize_[face0I],
            !(owner[faceMap_[face0I]] == celli)
        );
    vertLabels_[1] = pointMap_[face0[face0vert1]];
    // Info<< "Prism vertex 1: vertex " <<  face0[face0vert1]
    //    << " at position " << face0vert1 << " in face " << face0
    //    << endl;

    // Jump edge from face0 to face4
    label face4I =
        otherFace
        (
            numVert,
            face0[face0vert0],
            face0[face0vert1],
            face0I
        );
    const face& face4 = localFaces_[face4I];
    // Info<< "Stepped to prism face 4 " << face4
    //    << " across edge " << face0[face0vert0] << " "
    //    << face0[face0vert1]
    //    << endl;

    if (faceSize_[face4I] != 4)
    {
        // Info<< "Cannot be Prism Face 4 since size="
        //    << faceSize_[face4I] << endl;
        return false;
    }
    faceLabels_[4] = faceMap_[face4I];

    label face4vert1 = pointFaceIndex_[face0[face0vert1]][face4I];

    // Info<< "Prism vertex 1 also: vertex " <<  face4[face4vert1]
    //    << " at position " << face4vert1 << " in face " << face4
    //    << endl;

    // Walk face 4 from vertex 1 to 4
    label face4vert4 =
        nextVert
        (
            face4vert1,
            faceSize_[face4I],
            (owner[faceMap_[face4I]] == celli)
        );
    vertLabels_[4] = pointMap_[face4[face4vert4]];
    // Info<< "Prism vertex 4: vertex " <<  face4[face4vert4]
    //    << " at position " << face4vert4 << " in face " << face4
    //    << endl;

    // Walk face 4 from vertex 1 to 3
    label face4vert3 =
        nextVert
        (
            face4vert4,
            faceSize_[face4I],
            (owner[faceMap_[face4I]] == celli)
        );
    vertLabels_[3] = pointMap_[face4[face4vert3]];
    // Info<< "Prism vertex 3: vertex " <<  face4[face4vert3]
    //    << " at position " << face4vert3 << " in face " << face4
    //    << endl;

    // Jump edge from face4 to face1
    label face1I =
        otherFace
        (
            numVert,
            face4[face4vert3],
            face4[face4vert4],
            face4I
        );
    // const face& face1 = localFaces_[face1I];
    // Info<< "Stepped to prism face 1 " << face1
    //    << " across edge " << face4[face4vert3] << " "
    //    << face4[face4vert4]
    //    << endl;

    if (faceSize_[face1I] != 3)
    {
        // Info<< "Cannot be Prism Face 1 since size="
        //    << faceSize_[face1I] << endl;
        return false;
    }

    // Is prism for sure now
    if (checkOnly)
    {
        return true;
    }

    faceLabels_[1] = faceMap_[face1I];


    //
    // Walk to other faces and assign mapping.
    //


    // Walk face 0 from vertex 1 to 2
    label face0vert2 =
        nextVert
        (
            face0vert1,
            faceSize_[face0I],
            !(owner[faceMap_[face0I]] == celli)
        );
    vertLabels_[2] = pointMap_[face0[face0vert2]];
    // Info<< "Prism vertex 2: vertex " <<  face0[face0vert2]
    //    << " at position " << face0vert2 << " in face " << face0
    //    << endl;

    // Jump edge from face0 to face3
    label face3I =
        otherFace
        (
            numVert,
            face0[face0vert1],
            face0[face0vert2],
            face0I
        );
    faceLabels_[3] = faceMap_[face3I];
    const face& face3 = localFaces_[face3I];
    // Info<< "Stepped to prism face 3 " << face3
    //    << " across edge " << face0[face0vert1] << " "
    //    << face0[face0vert2]
    //    << endl;

    label face3vert2 = pointFaceIndex_[face0[face0vert2]][face3I];

    // Info<< "Prism vertex 2 also: vertex " <<  face3[face3vert2]
    //    << " at position " << face3vert2 << " in face " << face3
    //    << endl;

    label face3vert5 =
        nextVert
        (
            face3vert2,
            faceSize_[face3I],
            (owner[faceMap_[face3I]] == celli)
        );
    vertLabels_[5] = pointMap_[face3[face3vert5]];
    // Info<< "Prism vertex 5: vertex " <<  face3[face3vert5]
    //    << " at position " << face3vert5 << " in face " << face3
    //    << endl;

    // Jump edge from face0 to face2
    label face2I =
        otherFace
        (
            numVert,
            face0[face0vert2],
            face0[face0vert0],
            face0I
        );
    faceLabels_[2] = faceMap_[face2I];
    // const face& face2 = localFaces_[face2I];
    // Info<< "Stepped to prism face 2 " << face2
    //    << " across edge " << face0[face0vert2] << " "
    //    << face0[face0vert0]
    //    << endl;

    // label face2vert2 = pointFaceIndex_[face0[face0vert2]][face2I];
    // Info<< "Prism vertex 2 also: vertex " <<  face2[face2vert2]
    //    << " at position " << face2vert2 << " in face " << face2
    //    << endl;

    return true;
}


Foam::label Foam::prismMatcher::faceHashValue() const
{
    return 2*3 + 4*4;
}


bool Foam::prismMatcher::faceSizeMatch
(
    const faceList& faces,
    const labelList& myFaces
) const
{
    if (myFaces.size() != 5)
    {
        return false;
    }

    label nTris = 0;
    label nQuads = 0;

    forAll(myFaces, myFacei)
    {
        label size = faces[myFaces[myFacei]].size();

        if (size == 3)
        {
            nTris++;
        }
        else if (size == 4)
        {
            nQuads++;
        }
        else
        {
            return false;
        }
    }
    if ((nTris == 2) && (nQuads == 3))
    {
        return true;
    }
    else
    {
        return false;
    }
}


bool Foam::prismMatcher::isA(const primitiveMesh& mesh, const label celli)
{
    return matchShape
    (
        true,
        mesh.faces(),
        mesh.faceOwner(),
        celli,
        mesh.cells()[celli]
    );
}


bool Foam::prismMatcher::isA(const faceList& faces)
{
    // Do as if mesh with one cell only
    return matchShape
    (
        true,
        faces,                      // all faces in mesh
        labelList(faces.size(), 0), // cell 0 is owner of all faces
        0,                          // cell label
        identityMap(faces.size())      // faces of cell 0
    );
}


bool Foam::prismMatcher::matches
(
    const primitiveMesh& mesh,
    const label celli,
    cellShape& shape
)
{
    if
    (
        matchShape
        (
            false,
            mesh.faces(),
            mesh.faceOwner(),
            celli,
            mesh.cells()[celli]
        )
    )
    {
        shape = cellShape(model(), vertLabels());

        return true;
    }
    else
    {
        return false;
    }
}


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