Page MenuHomec4science
Files F91976103

stimulation_next_event.hh
No OneTemporary
Actions

File Metadata

Created
Sat, Nov 16, 07:45

stimulation_next_event.hh
View Options

/**
* @file stimulation_next_event.hh
*
* @author Guillaume Anciaux <guillaume.anciaux@epfl.ch>
* @author Jaehyun Cho <jaehyun.cho@epfl.ch>
*
* @date Mon Jun 30 12:36:27 2014
*
* @brief allows to explicitly set the global variable nb_step_next_event
*
* @section LICENSE
*
* Copyright (©) 2010-2011 EPFL (Ecole Polytechnique Fédérale de Lausanne)
* Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)
*
* LibMultiScale 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.
*
* LibMultiScale 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 Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with LibMultiScale. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef __LIBMULTISCALE_STIMULATION_NEXT_EVENT_HH__
#define __LIBMULTISCALE_STIMULATION_NEXT_EVENT_HH__
/* -------------------------------------------------------------------------- */
#include "stimulation.hh"
#include <limits>
/* -------------------------------------------------------------------------- */
__BEGIN_LIBMULTISCALE__
template <typename _Input>
class StimulationNextEvent : public Stimulation<_Input> {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
StimulationNextEvent(const std::string & name, ComponentLMInterface & d):
Stimulation<_Input>(name,d),
val(lm_uint_max),
incr(lm_uint_max)
{
};
void init() {
bool val_set = this->val != lm_uint_max;
bool incr_set = this->incr != lm_uint_max;
if (val_set && incr_set) {
LM_FATAL("only VAL or INCR can be set, not both");
} else if ( (!val_set && !incr_set) && this->frequency == 1) {
LM_FATAL("if neither VAL nor INCR are set, the FREQ keyword " <<
"has to be used");
}
if (this->frequency != 1) {
this->incr = this->frequency;
}
}
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
//! most generic stimulate function
void stimulate(_Input & cont, UInt stage);
void declareParams();
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
private:
UInt val;
UInt incr;
};
/* -------------------------------------------------------------------------- */
__END_LIBMULTISCALE__
#endif /* __LIBMULTISCALE_STIMULATION_NEXT_EVENT_HH__ */

Event Timeline

c4science · Help