hm_iterative.hh

Go to the documentation of this file.

/*!
 *
 * Copyright (C) 2015 Technical University of Liberec.  All rights reserved.
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License version 3 as published by the
 * Free Software Foundation. (http://www.gnu.org/licenses/gpl-3.0.en.html)
 * 
 * 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.
 *
 * 
 * @file    hm_iterative.hh
 * @brief   
 * @author  Jan Stebel
 */

#ifndef HM_ITERATIVE_HH_
#define HM_ITERATIVE_HH_

#include <memory>
#include <string>
#include <vector>
#include "input/input_type_forward.hh"
#include "input/accessors_forward.hh"
#include "coupling/equation.hh"
#include "flow/darcy_flow_interface.hh"
#include "mechanics/elasticity.hh"

class Mesh;
class FieldCommon;
class RichardsLMH;


/**
 * @brief Class for solution of fully coupled flow and mechanics using fixed-stress iterative splitting.
 * 
 * Flow and mechanics are solved separately and within each iteration the coupling terms are updated.
 * Here we use the fixed-stress splitting [see Mikelic&Wheeler, Comput. Geosci. 17(3), 2013] which uses
 * a tuning parameter "beta" to speed up the convergence.
 * 
 * TODO: The class is currently inherited from DarcyFlowInterface in order to provide MH_DofHandler for
 * transport processes. This should be changed as soon as we replace MH_DofHandler by fields for velocity
 * and pressure.
 */
class HM_Iterative : public DarcyFlowInterface {
public:
    
    class EqData : public FieldSet
    {
    public:
        EqData();
        
    };
    
    /// Define input record.
    static const Input::Type::Record & get_input_type();

    HM_Iterative(Mesh &mesh, Input::Record in_record);
    void initialize() override;
    void zero_time_step() override;
    void update_solution() override;
    const MH_DofHandler & get_mh_dofhandler() override;
    ~HM_Iterative();

private:

    static const int registrar;

    /// steady or unsteady water flow simulator based on MH scheme
    std::shared_ptr<RichardsLMH> flow_;

    /// solute transport with chemistry through operator splitting
    std::shared_ptr<Elasticity> mechanics_;
    
    EqData data_;

    /// Tuning parameter for iterative splitting.
    double beta_;
    
    /// Minimal number of iterations to perform.
    unsigned int min_it_;
    
    /// Maximal number of iterations.
    unsigned int max_it_;
    
    /// Absolute tolerance for difference between two succeeding iterations.
    double a_tol_;
    
    /// Relative tolerance for difference between two succeeding iterations.
    double r_tol_;

};

#endif /* HC_EXPLICIT_SEQUENTIAL_HH_ */