CG_solver.h

Go to the documentation of this file.

// 
//  This file is part of the FFEA simulation package
//  
//  Copyright (c) by the Theory and Development FFEA teams,
//  as they appear in the README.md file. 
// 
//  FFEA 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 3 of the License, or
//  (at your option) any later version.
// 
//  FFEA 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.
// 
//  You should have received a copy of the GNU General Public License
//  along with FFEA.  If not, see <http://www.gnu.org/licenses/>.
// 
//  To help us fund FFEA development, we humbly ask that you cite 
//  the research papers on the package.
//

#ifndef CG_SOLVER_H_INCLUDED
#define CG_SOLVER_H_INCLUDED

#include <stdlib.h>
#include <stdio.h>

#include "FFEA_return_codes.h"
#include "mat_vec_types.h"
#include "SparseMatrixFixedPattern.h"

class CG_solver {
public:
    CG_solver();
    ~CG_solver();

    int init(int N, scalar tol, int max_num_iterations);

    int solve(SparseMatrixFixedPattern *A, scalar *x, scalar *b);

    int solve(SparseMatrixFixedPattern *A, scalar *x, scalar *b, int num_iterations);

private:

    int N; 

    scalar tol; 

    int max_num_iterations; 

    scalar *inv_M; 

    scalar *d; 
    scalar *r; 
    scalar *q; 
    scalar *s; 

    scalar conjugate_gradient_residual(SparseMatrixFixedPattern *A, scalar *x, scalar *b);

    scalar residual2();

    void parallel_vector_add_self(scalar *v1, scalar a, scalar *v2);

    void parallel_vector_add(scalar *v1, scalar a, scalar *v2);

    scalar parallel_apply_preconditioner();

    void zero(scalar *v);

    scalar dot(scalar *a, scalar *b);
};

#endif