model_functions.h

Go to the documentation of this file.

/* 
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Daniel Abele, Elisabeth Kluth, Khoa Nguyen, David Kerkmann, Rene Schmieding
*
* Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
*
* 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 MIO_ABM_MODEL_FUNCTIONS_H
#define MIO_ABM_MODEL_FUNCTIONS_H
 
#include "abm/location.h"
#include "abm/person.h"
 
#include <vector>
 
namespace mio
{
namespace abm
{
 
ScalarType total_exposure_by_contacts(const ContactExposureRates& rates, const CellIndex cell_index,
                                      const VirusVariant virus, const AgeGroup age_receiver,
                                      size_t age_receiver_group_size, const LocalInfectionParameters& params);
 
ScalarType total_exposure_by_air(const AirExposureRates& rates, const CellIndex cell_index, const VirusVariant virus,
                                 const Parameters& global_params);
 
void add_exposure_contribution(AirExposureRates& local_air_exposure, ContactExposureRates& local_contact_exposure,
                               const Person& person, const Location& location, const Parameters& params,
                               const TimePoint t, const TimeSpan dt);
 
using PopulationByAge = CustomIndexArray<std::atomic_int_fast32_t, CellIndex, AgeGroup>;
 
void normalize_exposure_contribution(ContactExposureRates& local_contact_exposure,
                                     const PopulationByAge& local_population_by_age);
 
void interact(PersonalRandomNumberGenerator& personal_rng, Person& person, const Location& location,
              const PopulationByAge& local_population_by_age, const AirExposureRates& local_air_exposure,
              const ContactExposureRates& local_contact_exposure, const TimePoint t, const TimeSpan dt,
              const Parameters& global_parameters);
bool change_location(Person& person, const Location& destination, const TransportMode mode = TransportMode::Unknown,
                     const std::vector<uint32_t>& cells = {0});
 
void adjust_contact_rates(Location& location, size_t num_agegroups);
 
} // namespace abm
} // namespace mio
 
#endif // MIO_ABM_MODEL_FUNCTIONS_H