// -*- C++ -*-
//
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
//<LicenseText>
//
// CitcomS.py by Eh Tan, Eun-seo Choi, and Pururav Thoutireddy.
// Copyright (C) 2002-2005, California Institute of Technology.
//
// This program 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.
//
// This program 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 this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//</LicenseText>
//
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//

#include "config.h"
#include <vector>
#include "global_defs.h"
#include "journal/diagnostics.h"
#include "Boundary.h"


Boundary::Boundary() :
    Exchanger::Boundary()
{}


Boundary::Boundary(const All_variables* E,
		   bool excludeTop,
		   bool excludeBottom) :
    Exchanger::Boundary(),
    bnode_(E->lmesh.nno+1, -1)
{
    journal::debug_t debug("CitcomS-Exchanger");
    debug << journal::at(__HERE__) << journal::endl;
    // boundary = all - interior
    int maxNodes = E->lmesh.nno - (E->lmesh.nox-2)
	                         * (E->lmesh.noy-2)
	                         * (E->lmesh.noz-2);
    X_.reserve(maxNodes);
    nodeID_.reserve(maxNodes);
    normal_.reserve(maxNodes);

    // find out which nodes belong to the boundary and fill X_ with them
    // XXX: only implemented for regional model
    if (E->parallel.nprocxy == 1)
        initX(E, excludeTop, excludeBottom);
    else {
        journal::error_t error("CitcomS-Boundary");
        error << "Boundary is not implemented for full solver (yet)."
              << journal::endl;
    }

    // define the tight bounding box of the boundary
    initBBox(E);
    bbox_.print("CitcomS-Boundary-BBox");

    X_.shrink();
    X_.print("CitcomS-Boundary-X");
    nodeID_.shrink();
    nodeID_.print("CitcomS-Boundary-nodeID");
    normal_.shrink();
    normal_.print("CitcomS-Boundary-normal");
}


Boundary::~Boundary()
{}


// private functions

void Boundary::initBBox(const All_variables *E)
{
    bbox_ = tightBBox();

    // XXX: this is a hack
    bbox_[0][2] = E->sphere.ri;
    bbox_[1][2] = E->sphere.ro;
}


void Boundary::initX(const All_variables* E,
		     bool excludeTop, bool excludeBottom)
{
    const int itop = E->lmesh.noz;

    if(E->parallel.me_loc[3] == E->parallel.nprocz - 1) {
	if(!excludeTop) {

	    for(int k=1; k<=E->lmesh.noy; k++)
		for(int j=1; j<=E->lmesh.nox; j++) {
		    std::vector<int> normalFlag(Exchanger::DIM,0);
		    normalFlag[2] = 1;
		    checkSidewalls(E, j, k, normalFlag);
		    int node = ijk2node(E, itop, j, k);
		    appendNode(E, node, normalFlag);
		}
	}
	else
	    addSidewalls(E, itop, 1);
    }
    else
	addSidewalls(E, itop, 0);


    const int ibottom = 1;

    if(E->parallel.me_loc[3] == 0) {
	if(!excludeBottom) {
	    for(int k=1; k<=E->lmesh.noy; k++)
		for(int j=1; j<=E->lmesh.nox; j++) {
		    std::vector<int> normalFlag(Exchanger::DIM,0);
		    normalFlag[2] = -1;
		    checkSidewalls(E, j, k, normalFlag);
		    int node = ijk2node(E, ibottom, j, k);
		    appendNode(E, node, normalFlag);
		}
	}
	else
	    addSidewalls(E, ibottom, -1);
    }
    else
	addSidewalls(E, ibottom, 0);


    // add sidewall nodes which aren't at top or bottom
    for(int i=2; i<E->lmesh.noz; i++)
	addSidewalls(E, i, 0);

}


void Boundary::addSidewalls(const All_variables* E, int znode, int r_normal)
{
    const int i = znode;

    for(int k=1; k<=E->lmesh.noy; k++)
	for(int j=1; j<=E->lmesh.nox; j++) {
	    std::vector<int> normalFlag(Exchanger::DIM,0);
	    normalFlag[2] = r_normal;
	    if(checkSidewalls(E, j, k, normalFlag)) {
		int node = ijk2node(E, i, j, k);
		appendNode(E, node, normalFlag);
	    }
	}
}


bool Boundary::checkSidewalls(const All_variables* E,
			      int j, int k, std::vector<int>& normalFlag)
{
    bool isBoundary = false;

    if((E->parallel.me_loc[1] == 0) && (j == 1)) {
	isBoundary |= true;
	normalFlag[0] = -1;
    }

    if((E->parallel.me_loc[1] == E->parallel.nprocx - 1)
       && (j == E->lmesh.nox)) {
	isBoundary |= true;
	normalFlag[0] = 1;
    }

    if((E->parallel.me_loc[2] == 0) && (k == 1)) {
	isBoundary |= true;
	normalFlag[1] = -1;
    }

    if((E->parallel.me_loc[2] == E->parallel.nprocy - 1)
       && (k == E->lmesh.noy)) {
	isBoundary |= true;
	normalFlag[1] = 1;
    }

    return isBoundary;
}


int Boundary::ijk2node(const All_variables* E, int i, int j, int k)
{
    return i + (j-1)*E->lmesh.noz + (k-1)*E->lmesh.noz*E->lmesh.nox;
}


void Boundary::appendNode(const All_variables* E,
			  int node, const std::vector<int>& normalFlag)
{
    const int m = 1;

    std::vector<double> x(Exchanger::DIM);
    for(int d=0; d<Exchanger::DIM; d++)
	x[d] = E->sx[m][d+1][node];

    bnode_[node] = X_.size();
    X_.push_back(x);
    nodeID_.push_back(node);
    normal_.push_back(normalFlag);
}


// version
// $Id$

// End of file