Events

This page lists all the events that can be triggered in APSIM NG. Events are used to signal when certain actions should be performed within the simulation, allowing for a structured and organized approach to model execution.

Events are listed according the model that triggers them.

Simulation

Event Description
Commencing Invoked when simulation is about to commence before DoCommence event, giving all models a chance to initialise their state.
DoCommence Invoked to signal start of simulation after Commencing event.

Clock

Event Description
DoActualPlantGrowth Occurs each day to do actual plant growth.
DoActualPlantPartioning Occurs each day to do nutrient allocations.
DoCatchYesterday Occurs first each day to allow yesterdays values to be caught.
DoDailyInitialisation Occurs each day to do daily updates to models.
DoDCAPST Occurs each day when dcaps performs its calculations. This must happen between DoPotentialPlantGrowth and DoPotentialPlantPartitioning.
DoEndPasture Occurs after pasture growth and sends material to SOM.
DoEnergyArbitration Occurs when the canopy energy balance needs to be calculated with MicroClimate.
DoFertiliserApplications Invoked to perform all fertiliser applications.
DoInitialSummary Occurs each day to make the initial summary.
DoLifecycle Occurs each day to process a Pest and Disease lifecycle object.
DoManagement Occurs each day to do management actions and changes.
DoManagementCalculations Occurs each day after the simulation is done. Does management calculations.
DoNutrientArbitration Occurs each day to do nutrient arbitration.
DoPastureWater Initiates water calculations for the Pasture model.
DoPestDiseaseDamage Occurs to do Pest/Disease actions.
DoPhenology Occurs each day to perform phenology.
DoPotentialPlantGrowth Occurs each day to do potential growth.
DoPotentialPlantPartioning Occurs each day to do the water limited dm allocations. Water constraints to growth are accounted for in the calculation of DM supply and does initial N calculations to work out how much N uptake is required to pass to SoilArbitrator.
DoReport Occurs at end of each day.
DoReportCalculations Occurs when [do report calculations].
DoSoilErosion Occurs to tell soil erosion to perform its calculations.
DoSoilOrganicMatter Occurs each day to perform daily calculations of organic soil matter.
DoSoilTemperature Occurs to perform soil temperature calculations to do solute processes.
DoSoilWaterMovement Occurs each day to do water calculations such as irrigation, swim, water balance etc.
DoSolute Occurs each day.
DoStock Occurs each day to process stock methods in GrazPlan Stock.
DoSurfaceOrganicMatterDecomposition Occurs each day to do the daily residue decomposition.
DoSurfaceOrganicMatterPotentialDecomposition Occurs each day to perform daily calculations of organic soil matter.
DoUpdate Occurs near end of each day to do checks and finalising.
DoUpdateWaterDemand Occurs each day to do daily growth increment of total plant biomass.
DoWaterArbitration Occurs each day to do water arbitration.
DoWeather Occurs each day to calculate weather.
EndOfDay Occurs at end of each day.
EndOfMonth Occurs at end of each month.
EndOfSimulation Occurs at end of simulation.
EndOfWeek Occurs at end of each week.
EndOfYear Occurs at end of each year.
FinalInitialise Final Initialise event. Occurs once at start of simulation.
PartitioningComplete Occurs each day to finish partitioning.
PlantSowing This event is triggered when a plant is sown. It allows the model to initialize or reset any relevant state information related to the sowing process.
PrePhenology Occurs between DoWaterArbitration and DoPhenology. Performs sorghum final leaf no calcs.
StartOfDay Occurs at start of each day.
StartOfFirstDay Occurs once at the start of the first day of the simulation.
StartOfMonth Occurs at start of each month.
StartOfSimulation Occurs once at the start of the simulation.
StartOfWeek Occurs at start of each week.
StartOfYear Occurs at start of each year.
CLEMAgeResources CLEM Age your resources (eg. Decompose Fodder, Age your labour, Age your Animals).
CLEMAnimalBreeding CLEM Do Animal (Ruminant and Other) Breeding and milk calculations.
CLEMAnimalBuy CLEM buy animals including transporting and labour.
CLEMAnimalDeath CLEM Do Animal (Ruminant and Other) death.
CLEMAnimalManage CLEM Do Animal (Ruminant and Other) Herd Management (adjust breeders and sires etc.).
CLEMAnimalMark CLEM Do animal marking so complete before undertaking management decisions.
CLEMAnimalMilking CLEM Do Animal (Ruminant and Other) milking.
CLEMAnimalMilkProduction CLEM Calculate Animals (Ruminant and Other) milk production.
CLEMAnimalSell CLEM sell animals to market including transporting and labour.
CLEMAnimalStock CLEM stock animals to pasture availability or other metrics.
CLEMAnimalWeightGain CLEM Calculate Animals(Ruminant and Other) weight gain.
CLEMCalculateEcologicalState CLEM Calculate ecological state after all deaths and before management.
CLEMCalculateManure Request and allocate resources to all Activities based on UI Tree order of priority. Some activities will obtain resources here and perform actions later.
CLEMCollectManure Request and allocate resources to all Activities based on UI Tree order of priority. Some activities will obtain resources here and perform actions later.
CLEMDetachPasture CLEM detach pasture.
CLEMDoCutAndCarry CLEM cut and carry.
CLEMEndOfTimeStep CLEM end of timestep event.
CLEMFinalizeTimeStep CLEM finalize time-step before end.
CLEMGetResourcesRequired Request and perform the collection of manure after resources are allocated and manure produced in time-step.
CLEMHerdSummary CLEM event to calculate monthly herd summary.
CLEMInitialiseActivity CLEM initialise Activity occurs once at start of simulation.
CLEMInitialiseResource CLEM initialise Resources occurs once at start of simulation.
CLEMPastureReady CLEM pasture has been added and is ready for use.
CLEMPotentialIntake Get potential intake. This includes suckling milk consumption.
CLEMStartOfTimeStep CLEM start of timestep event.
CLEMUpdateLabourAvailability CLEM set labour availability after start of timestep and financial considerations.
CLEMUpdatePasture CLEM update pasture.
CLEMValidate CLEM validate all data entry.

GerminatingPhase

Event Description
SeedImbibed This event is raised when germination occurs by GerminatingPhase, signaling other models or processes to begin their activities related to the germinated seed.

Phenology

Event Purpose
PhaseChanged Indicates a new phase has started
PlantEmerged Signals that the emergence phase has been completed
StageWasReset Signals a manual reset of stage via SetToStage()
PostPhenology Raised after daily phenological timestep completes