File BG_Flood.h

#include "General.h"
#include "Param.h"
#include "Write_txtlog.h"
#include "ReadInput.h"
#include "ReadForcing.h"
#include "Setup_GPU.h"
#include "Util_CPU.h"
#include "Arrays.h"
#include "Forcing.h"
#include "Mesh.h"
#include "InitialConditions.h"
#include "Adaptation.h"
#include "Mainloop.h"
#include "Testing.h"

Public Functions

Type	Name
int	mainwork (Param XParam, Forcing< float > XForcing, Model< T > XModel, Model< T > XModel_g) Main model setup and execution routine for BG_Flood.

Public Functions Documentation

function mainwork

Main model setup and execution routine for BG_Flood.

template<class T>
int mainwork (
    Param XParam,
    Forcing < float > XForcing,
    Model < T > XModel,
    Model < T > XModel_g
)

Template parameters:

T Data type

Parameters:

XParam Model parameters
XForcing Forcing data
XModel Model structure (CPU)
XModel_g Model structure (GPU)

Returns:

Status code (0 for success)

This function performs the main setup and execution steps for the BG_Flood model: * Reads and verifies input/forcing data * Initializes mesh and initial conditions * Performs initial adaptation * Sets up GPU resources * Runs the main simulation loop (MainLoop) * Handles test mode if specified

Integrates all major model components and coordinates CPU/GPU execution.

The documentation for this class was generated from the following file src/BG_Flood.h