FLASH4.5 API

Generated from /asc/asci2/site/flashcode/secure/release_4p5/source/Grid/Grid_addToVar.F90 with ROBODoc v4.99.8 on Tue Mar 05 16:16:17 2019

TABLE OF CONTENTS


[Functions] source/Grid/Grid_addToVar

[top][index]

NAME

  Grid_addToVar

SYNOPSIS

  call Grid_addToVar(integer(in) :: srcVar,
                     integer(in) :: destVar,
                     real(in) :: multFactor,
                     logical(in) :: reset)

DESCRIPTION

   Compute solnData(srcVar,:,:,:)*multFactor and save in solnData(destVar,:,:,:).

   If reset is true, the destination variable is first zeroed;
   otherwise the product is added to the existing values of destVar.

   The operation is applied to interior cells of all LEAF blocks.

ARGUMENTS

   srcVar : the state variables to be used in the RHS of the expression

   destVar : the state variables to be used in the LHS of the expression

   multFactor : multiplication factor

   reset : indicates whether the destination variable should be zeroed first

NOTES

   srcVar == destVar is allowed and behaves as expected iff reset is .FALSE.

   For a copy call Grid_addToVar(srcVar, destVar, 1.0, .true.)