/******************************************************************************* * This file is part of SWIFT. * Copyright (c) 2016 Matthieu Schaller (schaller@strw.leidenuniv.nl) * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 Lesser General Public License * along with this program. If not, see . * ******************************************************************************/ #ifndef SWIFT_POTENTIAL_NONE_H #define SWIFT_POTENTIAL_NONE_H /* Config parameters. */ #include /* Some standard headers. */ #include /* Local includes. */ #include "error.h" #include "parser.h" #include "part.h" #include "physical_constants.h" #include "space.h" #include "units.h" /** * @brief External Potential Properties */ struct external_potential {}; /** * @brief Computes the time-step due to the acceleration from nothing * * @param time The current time. * @param potential The properties of the externa potential. * @param phys_const The physical constants in internal units. * @param g Pointer to the g-particle data. */ __attribute__((always_inline)) INLINE static float external_gravity_timestep( double time, const struct external_potential* restrict potential, const struct phys_const* restrict phys_const, const struct gpart* restrict g) { return FLT_MAX; } /** * @brief Computes the gravitational acceleration due to nothing * * We do nothing. * * @param time The current time. * @param potential The proerties of the external potential. * @param phys_const The physical constants in internal units. * @param g Pointer to the g-particle data. */ __attribute__((always_inline)) INLINE static void external_gravity_acceleration( double time, const struct external_potential* restrict potential, const struct phys_const* restrict phys_const, struct gpart* restrict g) {} /** * @brief Computes the gravitational potential energy due to nothing. * * We return 0. * * @param time The current time. * @param potential The #external_potential used in the run. * @param phys_const Physical constants in internal units. * @param g Pointer to the particle data. */ __attribute__((always_inline)) INLINE static float external_gravity_get_potential_energy( double time, const struct external_potential* potential, const struct phys_const* const phys_const, const struct gpart* g) { return 0.f; } /** * @brief Initialises the external potential properties in the internal system * of units. * * Nothing to do here. * * @param parameter_file The parsed parameter file * @param phys_const Physical constants in internal units * @param us The current internal system of units * @param potential The external potential properties to initialize */ static INLINE void potential_init_backend( struct swift_params* parameter_file, const struct phys_const* phys_const, const struct unit_system* us, const struct space* s, struct external_potential* potential) {} /** * @brief Prints the properties of the external potential to stdout. * * @param potential The external potential properties. */ static INLINE void potential_print_backend( const struct external_potential* potential) { message("External potential is 'No external potential'."); } #endif /* SWIFT_POTENTIAL_NONE_H */