LinkedListCube.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 LINKEDLISTCUBE_H_INCLUDED
#define LINKEDLISTCUBE_H_INCLUDED

#include "FFEA_return_codes.h"
#include "Face.h"

template <class T>
struct LinkedListNode {
    T *obj;

    LinkedListNode *next;

    int index;


    int x, y, z;
};

template <class T>
class LinkedListCube {
public:

    LinkedListCube();

    ~LinkedListCube();

    int alloc(int N_x, int N_y, int N_z, int max_num_nodes_in_pool);

    int alloc_dual(int N_x, int N_y, int N_z, int max_num_nodes_in_pool);

    int add_to_pool(T *t);

    int add_to_pool_dual(T *t);

    LinkedListNode<T> * get_from_pool(int i);

    void clear();
    void clear_layer(int l);
    void clear_shadow_layer();

    int add_node_to_stack(int i, int x, int y, int z);
    int add_node_to_stack_shadow(int i, int x, int y, int z);

    LinkedListNode<T> * get_top_of_stack(int x, int y, int z);

    int get_pool_size();

    void get_dim(int *Nx, int *Ny, int *Nz);

    int safely_swap_layers(); 

    void allow_swapping(); 
    void forbid_swapping(); 
    

protected:

    int N_x, N_y, N_z;

    int max_num_nodes_in_pool;

    int num_nodes_in_pool;

    LinkedListNode<T> **root1;
    LinkedListNode<T> **root2;
    LinkedListNode<T> **root;
    LinkedListNode<T> **root_shadow;

    LinkedListNode<T> *pool1;
    LinkedListNode<T> *pool2;
    LinkedListNode<T> *pool;
    LinkedListNode<T> *pool_shadow;

    int active_layer;
    int shadow_layer;

    void swap_layers(); 
    bool can_swap;

private:
    int add_index;

    void pbc(int *x, int *y, int *z);

};

#include "../src/LinkedListCube.tpp"

#endif