// -*- C++ -*-
//
// ----------------------------------------------------------------------
//
//                           Brad T. Aagaard
//                        U.S. Geological Survey
//
// {LicenseText}
//
// ----------------------------------------------------------------------
//

/** @file libsrc/materials/Material.hh
 *
 * @brief C++ abstract base class for Material object.
 *
 * Interface definition for material. The parameters for the material
 * physical properties include state variables associated with the
 * material constitutive model.
 */

#if !defined(pylith_materials_material_hh)
#define pylith_materials_material_hh

#include "pylith/utils/array.hh" // USES std::vector, double_array
#include <string> // HASA std::string

/// Namespace for pylith package
namespace pylith {
  namespace materials {
    class Material;
    class TestMaterial; // unit testing
  } // materials

  namespace feassemble {
    class Quadrature; // USES Quadrature
  } // feassemble

  namespace topology {
    class FieldsManager; // HOLDSA FieldsManager
  } // feassemble
} // pylith

/// Namespace for spatialdata package
namespace spatialdata {
  namespace spatialdb {
    class SpatialDB; // forward declaration
  } // spatialdb
  namespace geocoords {
    class CoordSys;
  } // geocoords
} // spatialdata

/// Namespace for spatialdata package
namespace ALE {
  class Mesh;
  template<class T> class Obj;
} // ALE

/// C++ abstract base class for Material object.
class pylith::materials::Material
{ // class Material
  friend class TestMaterial; // unit testing

  // PUBLIC METHODS /////////////////////////////////////////////////////
public :

  /// Default constructor.
  Material(void);

  /// Destructor.
  virtual
  ~Material(void);

  /** Get spatial dimension of material.
   *
   * @returns Spatial dimension.
   */
  int dimension(void) const;

  /** Set database for physical property parameters.
   *
   * @param value Pointer to database.
   */
  void db(spatialdata::spatialdb::SpatialDB* value);

  /** Set identifier of material.
   *
   * @param value Material identifier
   */
  void id(const int value);

  /** Get identifier of material.
   *
   * @returns Material identifier
   */
  int id(void) const;

  /** Set label of material.
   *
   * @param value Label of material
   */
  void label(const char* value);

  /** Get label of material.
   *
   * @returns Label of material
   */
  const std::string& label(void) const;

  /** Set current time step.
   *
   * @param dt Current time step.
   */
  virtual
  void timeStep(const double dt);

  /** Get current time step.
   *
   * @returns Current time step.
   */
  double timeStep(void) const;

  /** Initialize material by getting physical property parameters from
   * database.
   *
   * @param mesh PETSc mesh
   * @param cs Coordinate system associated with mesh
   * @param quadrature Quadrature for finite-element integration
   */
  void initialize(const ALE::Obj<ALE::Mesh>& mesh,
		  const spatialdata::geocoords::CoordSys* cs,
		  pylith::feassemble::Quadrature* quadrature);
  
  /** Get flag indicating whether Jacobian matrix must be reformed for
   * current state.
   *
   * @returns True if Jacobian matrix must be reformed, false otherwise.
   */
  bool needNewJacobian(void) const;

  /// Reset flag indicating whether Jacobian matrix must be reformed for
  /// current state.
  void resetNeedNewJacobian(void);

  // PROTECTED METHODS //////////////////////////////////////////////////
protected :

  /** Get names of values expected to be in database of parameters for
   *  physical properties.
   *
   * @returns Names of values
   */
  virtual
  const char** _dbValues(void) const = 0;

  /** Get number of values expected to be in database of parameters for
   *  physical properties.
   *
   * @returns Number of values
   */
  virtual
  int _numDBValues(void) const = 0;

  /** Get names of parameters for physical properties.
   *
   * @returns Names of parameters
   */
  virtual
  const char** _parameterNames(void) const = 0;

  /** Get number of values for each parameter for physical properties.
   *
   * @param numValues Array of number of values for each parameter.
   */
  virtual
  void _numParamValues(int_array* numValues) const = 0;

  /** Compute parameters from values in spatial database.
   *
   * @param paramVals Array of parameters
   * @param numParams Number of parameters
   * @param dbValues Array of database values
   * @param numValues Number of database values
   */
  virtual
  void _dbToParameters(std::vector<double_array>* const paramVals,
		       const double_array& dbValues) const = 0;

  // NOT IMPLEMENTED ////////////////////////////////////////////////////
private :

  /// Not implemented
  Material(const Material& m);

  /// Not implemented
  const Material& operator=(const Material& m);

  // PROTECTED MEMBERS //////////////////////////////////////////////////
protected :

  double _dt; ///< Current time step

  ///< Manager of parameters for physical properties of material
  topology::FieldsManager* _parameters;

  int _dimension; ///< Spatial dimension associated with material
  bool _needNewJacobian; ///< True if need to reform Jacobian, false otherwise

  // PRIVATE MEMBERS ////////////////////////////////////////////////////
private :

  /// Database of parameters for physical properties of material
  spatialdata::spatialdb::SpatialDB* _db;

  int _id; ///< Material identifier
  std::string _label; ///< Label of material

}; // class Material

#include "Material.icc" // inline methods

#endif // pylith_materials_material_hh


// End of file