DAObjFuncMass.C

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v3
 
\*---------------------------------------------------------------------------*/
 
#include "DAObjFuncMass.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
defineTypeNameAndDebug(DAObjFuncMass, 0);
addToRunTimeSelectionTable(DAObjFunc, DAObjFuncMass, dictionary);
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
DAObjFuncMass::DAObjFuncMass(
    const fvMesh& mesh,
    const DAOption& daOption,
    const DAModel& daModel,
    const DAIndex& daIndex,
    const DAResidual& daResidual,
    const word objFuncName,
    const word objFuncPart,
    const dictionary& objFuncDict)
    : DAObjFunc(
        mesh,
        daOption,
        daModel,
        daIndex,
        daResidual,
        objFuncName,
        objFuncPart,
        objFuncDict)
{
    // Assign type, this is common for all objectives
    objFuncDict_.readEntry<word>("type", objFuncType_);
 
    // setup the connectivity for mass. It does actually not depends on D
    // here we set zero level of D as a place holder.
    objFuncConInfo_ = {{"D"}};
 
    objFuncDict_.readEntry<scalar>("scale", scale_);
}
 
void DAObjFuncMass::calcObjFunc(
    const labelList& objFuncFaceSources,
    const labelList& objFuncCellSources,
    scalarList& objFuncFaceValues,
    scalarList& objFuncCellValues,
    scalar& objFuncValue)
{
    /*
    Description:
        Calculate the mass = density * volume of the mesh
 
    Input:
        objFuncFaceSources: List of face source (index) for this objective
    
        objFuncCellSources: List of cell source (index) for this objective
 
    Output:
        objFuncFaceValues: the discrete value of objective for each face source (index). 
        This  will be used for computing df/dw in the adjoint.
    
        objFuncCellValues: the discrete value of objective on each cell source (index). 
        This will be used for computing df/dw in the adjoint.
    
        objFuncValue: the sum of objective, reduced across all processors and scaled by "scale"
    */
 
    // initialize faceValues to zero
    forAll(objFuncCellValues, idxI)
    {
        objFuncCellValues[idxI] = 0.0;
    }
    // initialize objFunValue
    objFuncValue = 0.0;
 
    const objectRegistry& db = mesh_.thisDb();
    const volScalarField& rho = db.lookupObject<volScalarField>("solid:rho");
 
    // calculate mass
    forAll(objFuncCellSources, idxI)
    {
        const label& cellI = objFuncCellSources[idxI];
        scalar volume = mesh_.V()[cellI];
        objFuncCellValues[idxI] = scale_ * volume * rho[cellI];
        objFuncValue += objFuncCellValues[idxI];
    }
 
    // need to reduce the sum of force across all processors
    reduce(objFuncValue, sumOp<scalar>());
 
    return;
}
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// ************************************************************************* //