SparseMatrixFixedPattern.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 SPARSEMATRIXFIXEDPATTERN_H_INCLUDED
#define SPARSEMATRIXFIXEDPATTERN_H_INCLUDED

#include "FFEA_return_codes.h"
#include "mat_vec_types.h"
#include "mat_vec_fns.h"
#include "SparseMatrixTypes.h"
#include <iostream>
#include <stdlib.h>

using namespace std;

class SparseMatrixFixedPattern {
public:
    SparseMatrixFixedPattern();

    ~SparseMatrixFixedPattern();

    int init(int num_rows, int num_nonzero_elements, sparse_entry *entry, int *key, sparse_entry_sources *source_list);
    int init(int num_rows, int num_entries, scalar *entries, int *key, int *col_indices);

    void build();

    void apply(scalar *in, scalar *result);

    void apply(vector3 *in, vector3 *result);

    void block_apply(vector3 *in, vector3 *result);
    
    void block_apply(vector3 **in, vector3 **result);

    void block_apply(vector3 **in);

    SparseMatrixFixedPattern * apply(SparseMatrixFixedPattern *in);

    void calc_inverse_diagonal(scalar *inv_D);

    void print();

    void print_dense();

    void print_dense_to_file(vector3 *a);

    void print_row_column();

    void check_symmetry();

    void am_i_diagonally_dominant();

    sparse_entry * get_entries();

    int * get_key();

    int get_num_nonzero_elements();

    int get_num_rows();

    int get_num_columns();

private:

    int num_rows;

    int num_nonzero_elements;

    sparse_entry *entry;

    int *key;

    scalar **diagonal;

    sparse_entry_sources *source_list;
};

#endif