assemble_interface.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * 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 Lesser General Public License for more details.
 */
 
#ifndef __H__UG__LIB_DISC__ASSEMBLE__
#define __H__UG__LIB_DISC__ASSEMBLE__
 
#include "lib_grid/tools/selector_grid.h"
#include "lib_grid/tools/grid_level.h"
#include "lib_disc/spatial_disc/ass_tuner.h"
 
namespace ug{
 
//predeclaration
template <typename TAlgebra>
class IConstraint;
 
 
 
 
template <typename TAlgebra>
class IAssemble
{
  public:
    typedef TAlgebra algebra_type;
 
    typedef typename TAlgebra::matrix_type matrix_type;
 
    typedef typename TAlgebra::vector_type vector_type;
 
  public:
 
    virtual void assemble_jacobian(matrix_type& J, const vector_type& u, const GridLevel& gl) = 0;
    void assemble_jacobian(matrix_type& J, const vector_type& u)
    {assemble_jacobian(J,u,GridLevel());}
 
 
    virtual void assemble_defect(vector_type& d, const vector_type& u, const GridLevel& gl) = 0;
    void assemble_defect(vector_type& d, const vector_type& u)
    {assemble_defect(d,u, GridLevel());}
 
 
    virtual void assemble_linear(matrix_type& A, vector_type& b, const GridLevel& gl) = 0;
    void assemble_linear(matrix_type& A, vector_type& b)
    {assemble_linear(A,b, GridLevel());}
 
    virtual void assemble_rhs(vector_type& rhs, const vector_type& u, const GridLevel& gl) = 0;
    virtual void assemble_rhs(vector_type& rhs, const vector_type& u)
    {assemble_rhs(rhs, u, GridLevel());}
 
 
    virtual void assemble_rhs(vector_type& b, const GridLevel& gl) = 0;
    void assemble_rhs(vector_type& b)
    {assemble_rhs(b, GridLevel());}
 
 
    virtual void adjust_solution(vector_type& u, const GridLevel& gl) = 0;
    void adjust_solution(vector_type& u)
    {adjust_solution(u, GridLevel());}
 
    virtual void assemble_mass_matrix(matrix_type& M, const vector_type& u, const GridLevel& gl)
    {UG_THROW("IAssemble: assemble_mass_matrix not implemented.");}
    void assemble_mass_matrix(matrix_type& M, const vector_type& u)
    {assemble_mass_matrix(M,u,GridLevel());}
 
    virtual void assemble_stiffness_matrix(matrix_type& A, const vector_type& u, const GridLevel& gl)
    {UG_THROW("IAssemble: assemble_stiffness_matrix not implemented.");}
    void assemble_stiffness_matrix(matrix_type& A, const vector_type& u)
    {assemble_stiffness_matrix(A,u,GridLevel());}
 
    virtual SmartPtr<AssemblingTuner<TAlgebra> > ass_tuner() = 0;
    virtual ConstSmartPtr<AssemblingTuner<TAlgebra> > ass_tuner() const = 0;
 
    virtual size_t num_constraints() const = 0;
 
    virtual SmartPtr<IConstraint<TAlgebra> > constraint(size_t i) = 0;
 
    virtual ~IAssemble(){};
 
};
 
 
}; // name space ug
 
#endif /* __H__UG__LIB_DISC__ASSEMBLE__ */