ModelFactory.h

/* Copyright 2016 Kristofer Björnson
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


#ifndef COM_DAFER45_TBTK_MODEL_FACTORY
#define COM_DAFER45_TBTK_MODEL_FACTORY

#include "TBTK/Geometry.h"
#include "TBTK/Model.h"
#include "TBTK/StateSet.h"
#include "TBTK/StateTreeNode.h"
#include "TBTK/UnitCell.h"

#include <complex>
#include <initializer_list>

namespace TBTK{

class ModelFactory{
public:
    static Model* createSquareLattice(
        std::initializer_list<int> size,
        std::initializer_list<bool> periodic,
        std::complex<double> t
    );

    static Model* createHexagonalLattice(
        std::initializer_list<int> size,
        std::initializer_list<bool> periodic,
        std::complex<double> t
    );

    static Model* createModel(
        const StateSet &stateSet,
        const AbstractOperator &o = DefaultOperator()
    );

    static Model* createModel(
        const StateSet &stateSet,
        const StateTreeNode &stateTreeNode,
        const AbstractOperator &o = DefaultOperator()
    );

    static Model* createModel(
        const UnitCell &unitCell,
        std::initializer_list<int> size,
        std::initializer_list<bool> periodic,
        const bool *includedCells = NULL,
        const AbstractOperator &o = DefaultOperator()
    );

    static void addSquareGeometry(
        Model *model,
        std::initializer_list<int> size
    );

    static void addHexagonalGeometry(
        Model *model,
        std::initializer_list<int> size
    );

    static Model* merge(
        std::initializer_list<Model*> models
    );
private:
    static void createSquareLattice1D(
        Model *model,
        std::initializer_list<int> size,
        std::initializer_list<bool> periodic,
        std::complex<double> t
    );

    static void createSquareLattice2D(
        Model *model,
        std::initializer_list<int> size,
        std::initializer_list<bool> periodic,
        std::complex<double> t
    );

    static void createSquareLattice3D(
        Model *model,
        std::initializer_list<int> size,
        std::initializer_list<bool> periodic,
        std::complex<double> t
    );

    static Model* createModel1D(
        const UnitCell &unitCell,
        std::initializer_list<int> size,
        std::initializer_list<bool> periodic,
        const bool *includedCells,
        const AbstractOperator &o
    );

    static Model* createModel2D(
        const UnitCell &unitCell,
        std::initializer_list<int> size,
        std::initializer_list<bool> periodic,
        const bool *includedCells,
        const AbstractOperator &o
    );

    static Model* createModel3D(
        const UnitCell &unitCell,
        std::initializer_list<int> size,
        std::initializer_list<bool> periodic,
        const bool *includedCells,
        const AbstractOperator &o
    );

    static void addSquareGeometry1D(
        Model *model,
        std::initializer_list<int> size
    );

    static void addSquareGeometry2D(
        Model *model,
        std::initializer_list<int> size
    );

    static void addSquareGeometry3D(
        Model *model,
        std::initializer_list<int> size
    );
};

};  //End of namespace TBTK

#endif