Line data    Source code

       1              : /*
       2              :  * Copyright (c) 2014-2015:  G-CSC, Goethe University Frankfurt
       3              :  * Author: Martin Rupp
       4              :  * 
       5              :  * This file is part of UG4.
       6              :  * 
       7              :  * UG4 is free software: you can redistribute it and/or modify it under the
       8              :  * terms of the GNU Lesser General Public License version 3 (as published by the
       9              :  * Free Software Foundation) with the following additional attribution
      10              :  * requirements (according to LGPL/GPL v3 §7):
      11              :  * 
      12              :  * (1) The following notice must be displayed in the Appropriate Legal Notices
      13              :  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
      14              :  * 
      15              :  * (2) The following notice must be displayed at a prominent place in the
      16              :  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
      17              :  * 
      18              :  * (3) The following bibliography is recommended for citation and must be
      19              :  * preserved in all covered files:
      20              :  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
      21              :  *   parallel geometric multigrid solver on hierarchically distributed grids.
      22              :  *   Computing and visualization in science 16, 4 (2013), 151-164"
      23              :  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
      24              :  *   flexible software system for simulating pde based models on high performance
      25              :  *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
      26              :  * 
      27              :  * This program is distributed in the hope that it will be useful,
      28              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      29              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
      30              :  * GNU Lesser General Public License for more details.
      31              :  */
      32              : 
      33              : #ifndef __H__LIB_ALGEBRA__OPERATOR__ENERGY_CONVERGENCE_CHECK__
      34              : #define __H__LIB_ALGEBRA__OPERATOR__ENERGY_CONVERGENCE_CHECK__
      35              : 
      36              : #include "convergence_check.h"
      37              : 
      38              : namespace ug{
      39              : 
      40              : 
      41              : template <typename TVector>
      42              : class EnergyConvCheck : public StdConvCheck<TVector>
      43              : {
      44              :         typedef StdConvCheck<TVector> base_type;
      45              :         public:
      46            0 :         EnergyConvCheck() : base_type() {}
      47            0 :         EnergyConvCheck(int maxSteps, number minDefect, number relReduction) : base_type(maxSteps, minDefect, relReduction) {}
      48            0 :         EnergyConvCheck(int maxSteps, number minDefect, number relReduction, bool verbose)
      49            0 :                  : base_type(maxSteps, minDefect, relReduction, verbose) {}
      50            0 :         EnergyConvCheck(int maxSteps, number minDefect, number relReduction, bool verbose,bool suppressUnsuccessful)
      51            0 :                  : base_type(maxSteps, minDefect, relReduction, verbose, suppressUnsuccessful) {}
      52              : 
      53            0 :         virtual SmartPtr<IConvergenceCheck<TVector> > clone()
      54              :         {
      55            0 :                 SmartPtr<EnergyConvCheck<TVector> > newInst(new EnergyConvCheck<TVector>);
      56              :                 // use std assignment (implicit member-wise is fine here)
      57            0 :                 *newInst = *this;
      58            0 :                 return newInst;
      59              :         }
      60              : 
      61            0 :         void start(const TVector& d)
      62              :         {
      63            0 :                 base_type::start_defect(energy_norm(d));
      64            0 :         }
      65            0 :         void update(const TVector& d)
      66              :         {
      67            0 :                 base_type::update_defect(energy_norm(d));
      68            0 :         }
      69              : 
      70            0 :         double energy_norm(const TVector &d)
      71              :         {
      72            0 :                 if(tmp.valid() == false || tmp->size() != d.size())
      73              :                 {
      74            0 :                         tmp = d.clone_without_values();
      75            0 :                         tmp2 = d.clone_without_values();
      76              :                 }
      77              :                 TVector &t = *tmp;
      78              :                 TVector &t2 = *tmp2;
      79            0 :                 t = d;
      80              : #ifdef UG_PARALLEL
      81              :                 t.change_storage_type(PST_CONSISTENT);
      82              : #endif
      83            0 :                 m_op->apply(t2, t);
      84            0 :                 return sqrt(VecProd(t, t2));
      85              :         }
      86              : 
      87            0 :         virtual std::string config_string() const
      88              :         {
      89            0 :                 std::stringstream ss;
      90            0 :                 ss << "EnergyConvCheck( max steps = " << base_type::m_maxSteps << ", min defect = " << base_type::m_minDefect <<
      91            0 :                                 ", relative reduction = " << base_type::m_relReduction << ")";
      92            0 :                 return ss.str();
      93            0 :         }
      94              : 
      95            0 :         void set_linear_operator(SmartPtr<ILinearOperator<TVector> > op)
      96              :         {
      97            0 :                 m_op = op;
      98            0 :         }
      99              : 
     100              : private:
     101              :         SmartPtr<TVector> tmp, tmp2;
     102              :         SmartPtr<ILinearOperator<TVector> > m_op;
     103              : 
     104              : };
     105              : 
     106              : 
     107              : }
     108              : 
     109              : #endif /* __H__LIB_ALGEBRA__OPERATOR__ENERGY_CONVERGENCE_CHECK__ */