GeoGridConfig.h

Go to the documentation of this file.

#pragma once
/*
 *  This 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
 *  any later version.
 *  The software 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 the software. If not, see <http://www.gnu.org/licenses/>.
 *
 *  Copyright 2018, 2019, Jan Broeckhove and Bistromatics group.
 */

#include "contact/ContactPool.h"
#include "contact/IdSubscriptArray.h"
#include "pop/Person.h"
#include "util/SegmentedVector.h"

#include <boost/property_tree/ptree_fwd.hpp>

#include <memory>
#include <ostream>

namespace geopop {

class GeoGrid;

class GeoGridConfig
{
public:
        GeoGridConfig();

        explicit GeoGridConfig(const boost::property_tree::ptree& configPt);

        stride::ContactType::IdSubscriptArray<unsigned int> people {0U, 500U, 3000U, 20U, 2000U, 2000U};

        stride::ContactType::IdSubscriptArray<unsigned int> pools {1U, 25U, 20U, 1U, 1U, 1U};

        // -----------------------------------------------------------------------------------------
        // Parameters set by constructor with configuration property tree.
        // -----------------------------------------------------------------------------------------
        struct
        {
                double participation_college;

                double particpation_workplace;

                double fraction_college_commuters;

                double fraction_workplace_commuters;

                unsigned int pop_size;
        } param;

        // -----------------------------------------------------------------------------------------
        // The reference Households used to generate the population by random draws.
        // -----------------------------------------------------------------------------------------
        struct
        {
                unsigned int person_count = 0U;

                std::vector<std::vector<unsigned int>> ages{};
        } refHH;

        // -----------------------------------------------------------------------------------------
        // These are numbers derived from the reference households, the target size of the generated
        // population and the input parameters relating participation in college and workplace.
        // These numbers are used as targets in the population generation process and are reproduced
        // (to very close approximation) in the generated population.
        // The numbers are set by the SetData method.
        // -----------------------------------------------------------------------------------------
        struct
        {
                unsigned int popcount_k12school;

                unsigned int popcount_college;

                unsigned int popcount_workplace;

                unsigned int count_households;
        } info;

        // -----------------------------------------------------------------------------------------
        // -----------------------------------------------------------------------------------------
        void SetData(const std::string& householdsFileName);
};

} // namespace geopop