pfem.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2025   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef pfem_h
#define pfem_h
 
#include "engngm.h"
#include "sparselinsystemnm.h"
#include "sparsemtrx.h"
#include "primaryfield.h"
#include "dofdistributedprimaryfield.h"
#include "pfemnumberingschemes.h"
#include "materialinterface.h"
#include "assemblercallback.h"
 


#define _IFT_PFEM_Name "pfem"
#define _IFT_PFEM_deltat "deltat"
#define _IFT_PFEM_mindeltat "mindeltat"
#define _IFT_PFEM_alphashapecoef "alphashapecoef"
#define _IFT_PFEM_particalRemovalRatio "removalratio"
#define _IFT_PFEM_printVolumeReport "volumereport"
#define _IFT_PFEM_discretizationScheme "scheme"
#define _IFT_PFEM_associatedMaterial "material"
#define _IFT_PFEM_associatedCrossSection "cs"
#define _IFT_PFEM_pressureBC "pressure"
#define _IFT_PFEM_rtolv "rtolv"
#define _IFT_PFEM_rtolp "rtolp"
#define _IFT_PFEM_maxiter "maxiter"

 
namespace oofem {
class PFEMPressureRhsAssembler : public VectorAssembler
{
public:
    void vectorFromElement(FloatArray &vec, Element &element, TimeStep *tStep, ValueModeType mode) const override;
};

class PFEMCorrectionRhsAssembler : public VectorAssembler
{
protected:
    double deltaT;
 
public:
    PFEMCorrectionRhsAssembler(double deltaT) : VectorAssembler(), deltaT(deltaT) {}
 
    void vectorFromElement(FloatArray &vec, Element &element, TimeStep *tStep, ValueModeType mode) const override;
    void locationFromElement(IntArray &loc, Element &element, const UnknownNumberingScheme &s, IntArray *dofIds = nullptr) const override;
};

class PFEMLaplaceVelocityAssembler : public VectorAssembler
{
    void vectorFromElement(FloatArray &vec, Element &element, TimeStep *tStep, ValueModeType mode) const override;
    void locationFromElement(IntArray &loc, Element &element, const UnknownNumberingScheme &s, IntArray *dofIds = nullptr) const override;
};

class PFEMMassVelocityAssembler : public VectorAssembler
{
    void vectorFromElement(FloatArray &vec, Element &element, TimeStep *tStep, ValueModeType mode) const override;
    void locationFromElement(IntArray &loc, Element &element, const UnknownNumberingScheme &s, IntArray *dofIds = nullptr) const override;
};

class PFEMPressureLaplacianAssembler : public MatrixAssembler
{
public:
    void matrixFromElement(FloatMatrix &mat, Element &element, TimeStep *tStep) const override;
    void locationFromElement(IntArray &loc, Element &element, const UnknownNumberingScheme &s, IntArray *dofIds = nullptr) const override;
};

class PFEM : public EngngModel
{
protected:
    std :: unique_ptr< SparseLinearSystemNM > nMethod;
    LinSystSolverType solverType;
    SparseMtrxType sparseMtrxType;

    FloatArray avLhs;
    std :: unique_ptr< SparseMtrx >pLhs;
    FloatArray vLhs;
 
    // TODO: consider using DofDistributedPrimaryField for pressure and velocity
    PrimaryField PressureField;
    PrimaryField VelocityField;
    FloatArray AuxVelocity;

    double deltaT;
    double minDeltaT;
    double alphaShapeCoef;
    double particleRemovalRatio;
    double rtolv, rtolp;
    int maxiter;

    double domainVolume;
    bool printVolumeReport;

    int discretizationScheme;

    int associatedCrossSection;
    int associatedMaterial;
    int associatedPressureBC;

    PressureNumberingScheme pns;
    AuxVelocityNumberingScheme avns;
    VelocityNumberingScheme vns;
    VelocityNumberingScheme prescribedVns;
 
public:
    PFEM(int i, EngngModel *_master = nullptr) :
        EngngModel(i, _master)
        , avLhs()
        , pLhs()
        , vLhs()
        , PressureField(this, 1, FT_Pressure, 1)
        , VelocityField(this, 1, FT_Velocity, 1)
        , pns()
        , vns(false)
        , prescribedVns(true)
    {
        ndomains = 1;
        nMethod = NULL;
        domainVolume = 0.0;
        printVolumeReport = false;
        discretizationScheme = 1; // implicit iterative scheme is default
        associatedCrossSection = 0;
        associatedMaterial = 0;
        associatedPressureBC = 0;
    }
    ~PFEM() { }
 
    void solveYourselfAt(TimeStep *) override;
    void updateYourself(TimeStep *tStep) override;
 
    double giveUnknownComponent(ValueModeType mode, TimeStep *tStep, Domain *d, Dof *dof) override;
 
    void saveContext(DataStream &stream, ContextMode mode) override;
    void restoreContext(DataStream &stream, ContextMode mode) override;
 
    TimeStep *giveNextStep() override;
    TimeStep *giveSolutionStepWhenIcApply(bool force = false) override;
    NumericalMethod *giveNumericalMethod(MetaStep *) override;

    void preInitializeNextStep() override;
 
    //equation numbering using PressureNumberingScheme
    int forceEquationNumbering(int id) override;
 
    int requiresUnknownsDictionaryUpdate() override { return true; }
 

    void initializeFrom(InputRecord &ir) override;
 
    // consistency check
    int checkConsistency() override; // returns nonzero if o.k.
    // identification
    const char *giveClassName() const override { return "PFEM"; }
    fMode giveFormulation() override { return AL; }
    //    fMode giveFormulation() { return TL; }

    void printDofOutputAt(FILE *stream, Dof *iDof, TimeStep *atTime) override;
 
    int giveNumberOfDomainEquations(int, const UnknownNumberingScheme &num) override;
 
    int giveNewEquationNumber(int domain, DofIDItem) override;
    int giveNewPrescribedEquationNumber(int domain, DofIDItem) override;
 
    int giveUnknownDictHashIndx(ValueModeType mode, TimeStep *stepN) override; // { return ( int ) mode; }
    void updateDofUnknownsDictionary(DofManager *inode, TimeStep *tStep) override;

    void updateDofUnknownsDictionaryPressure(DofManager *inode, TimeStep *tStep);
    void updateDofUnknownsDictionaryVelocities(DofManager *inode, TimeStep *tStep);
    void resetEquationNumberings();

    int giveAssociatedMaterialNumber() { return associatedMaterial; }
    int giveAssociatedCrossSectionNumber() { return associatedCrossSection; }
    int giveAssociatedPressureBC() { return associatedPressureBC; }
 
protected:
    void updateInternalState(TimeStep *);
    void applyIC(TimeStep *);
    void deactivateTooCloseParticles();
};
} // end namespace oofem
#endif // pfem_h