// $Id$
/*****************************************************************************
 *   Copyright (C) 2008-2009 by Melanie Darcis                               *
 *   Institute of Hydraulic Engineering                                      *
 *   University of Stuttgart, Germany                                        *
 *   email: <givenname>.<name>@iws.uni-stuttgart.de                          *
 *                                                                           *
 *   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, as long as this copyright notice    *
 *   is included in its original form.                                       *
 *                                                                           *
 *   This program is distributed WITHOUT ANY WARRANTY.                       *
 *****************************************************************************/
#ifndef TUTORIALSPATIALPARAMETERS_COUPLED_HH
#define TUTORIALSPATIALPARAMETERS_COUPLED_HH

// include parent spatialparameters
#include <dumux/new_material/spatialparameters/boxspatialparameters.hh>

// include material laws
#include <dumux/new_material/fluidmatrixinteractions/2p/regularizedbrookscorey.hh>
#include <dumux/new_material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh>
#include <dumux/new_material/fluidmatrixinteractions/2p/linearmaterial.hh>
#include <dumux/new_material/fluidmatrixinteractions/2p/efftoabslaw.hh>

namespace Dumux
{

template<class TypeTag>
class TutorialSpatialParameters: public BoxSpatialParameters<TypeTag> /*@\label{tutorial-coupled:tutorialSpatialParameters}@*/
{
	// Get informations for current implementation via property system
	typedef typename GET_PROP_TYPE(TypeTag, PTAG(Grid)) Grid;
	typedef typename GET_PROP_TYPE(TypeTag, PTAG(GridView)) GridView;
	typedef typename GET_PROP_TYPE(TypeTag, PTAG(Scalar)) Scalar;

	enum
	{
		dim = Grid::dimension,
		dimWorld = Grid::dimensionworld,
	};

	// Get object types for function arguments
	typedef typename GET_PROP_TYPE(TypeTag, PTAG(FVElementGeometry)) FVElementGeometry;
	typedef typename Grid::Traits::template Codim<0>::Entity Element;

	// select materialLaw to be used
	typedef RegularizedBrooksCorey<Scalar> RawMaterialLaw;
    //typedef LinearMaterial<Scalar>		RawMaterialLaw;		// example for linear Materiallaw
public:
    // adapter for absolute law
	typedef EffToAbsLaw<RawMaterialLaw> MaterialLaw;

	// determine appropriate parameters depening on selected materialLaw
	typedef typename MaterialLaw::Params MaterialLawParams;


	// method returning the intrinsic permeability tensor K depending
	// on the position within the domain
	const Dune::FieldMatrix<Scalar, dim, dim> &intrinsicPermeability(const Element &element,
													const FVElementGeometry &fvElemGeom,
													int scvIdx) const
	{
		return K_;
	}

	// method returning the porosity of the porous matrix depending on
	// the position within the domain
	double porosity(const Element &element,
					const FVElementGeometry &fvElemGeom,
					int scvIdx) const
	{
		return 0.2;
	}

	// return the materialLaw context (i.e. BC, regularizedVG, etc) depending on the position
	const MaterialLawParams& materialLawParams(const Element &element,
											const FVElementGeometry &fvElemGeom,
											int scvIdx) const
	{
//		if (element.center()>= 783636)
//			return UpperBoundaryMaterialParams_;
		return materialParams_;
	}

	// constructor
	TutorialSpatialParameters(const GridView& gridView) :
		BoxSpatialParameters<TypeTag>(gridView), K_(0)
	{
		for (int i = 0; i < dim; i++)
			K_[i][i] = 1e-7;

		//set residual saturations
		materialParams_.setSwr(0.0);
		materialParams_.setSnr(0.0);

		//brooks-corey law
		materialParams_.setPe(0.0);
		materialParams_.setAlpha(2.0);

//		//linear material law
//		materialParams_.setEntryPC(0.0);
//		materialParams_.setMaxPC(0.0);
	}

private:
	Dune::FieldMatrix<Scalar, dim, dim> K_;
	// Object that helds the values/parameters of the selected material law.
	MaterialLawParams materialParams_;
};
} // end namespace
#endif