Skip to content

File FlowCPU.h

FileList > src > FlowCPU.h

Go to the source code of this file

  • #include "General.h"
  • #include "Param.h"
  • #include "Arrays.h"
  • #include "Forcing.h"
  • #include "Util_CPU.h"
  • #include "MemManagement.h"
  • #include "Halo.h"
  • #include "GridManip.h"
  • #include "Gradients.h"
  • #include "Kurganov.h"
  • #include "Advection.h"
  • #include "Friction.h"
  • #include "Updateforcing.h"
  • #include "Reimann.h"

Public Functions

Type Name
void FlowCPU (Param XParam, Loop< T > & XLoop, Forcing< float > XForcing, Model< T > XModel)
Main CPU flow solver for the flood model.
void HalfStepCPU (Param XParam, Loop< T > & XLoop, Forcing< float > XForcing, Model< T > XModel)
Debugging flow step for the flood model.

Public Functions Documentation

function FlowCPU

Main CPU flow solver for the flood model.

template<class T>
void FlowCPU (
    Param XParam,
    Loop < T > & XLoop,
    Forcing < float > XForcing,
    Model < T > XModel
) 

Executes predictor and corrector steps, applies atmospheric, wind, and river forcing, updates advection and friction terms, and manages halo and gradient reconstruction for all blocks.

Template parameters:

  • T Data type (float or double)

Parameters:

  • XParam Simulation parameters
  • XLoop Loop control and time stepping
  • XForcing Forcing data (atmospheric, wind, river, rain)
  • XModel Model data structure

function HalfStepCPU

Debugging flow step for the flood model.

template<class T>
void HalfStepCPU (
    Param XParam,
    Loop < T > & XLoop,
    Forcing < float > XForcing,
    Model < T > XModel
) 

Runs a simplified flow step for debugging the main engine, including forcing, advection, friction, and halo/gradient reconstruction.

Template parameters:

  • T Data type (float or double)

Parameters:

  • XParam Simulation parameters
  • XLoop Loop control and time stepping
  • XForcing Forcing data (atmospheric, wind, river, rain)
  • XModel Model data structure

Debugging flow step This function was created to debug the main engine of the model



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