cbs.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 cbs_h
#define cbs_h
 
#include "fluidmodel.h"
#include "sparselinsystemnm.h"
#include "sparsemtrx.h"
#include "dofdistributedprimaryfield.h"
//<RESTRICTED_SECTION>
#include "materialinterface.h"
//</RESTRICTED_SECTION>
 
#include "unknownnumberingscheme.h"


#define _IFT_CBS_Name "cbs"
#define _IFT_CBS_deltat "deltat"
#define _IFT_CBS_mindeltat "mindeltat"
#define _IFT_CBS_cmflag "cmflag"
#define _IFT_CBS_theta1 "theta1"
#define _IFT_CBS_theta2 "theta2"
#define _IFT_CBS_scaleflag "scaleflag"
#define _IFT_CBS_lscale "lscale"
#define _IFT_CBS_uscale "uscale"
#define _IFT_CBS_dscale "dscale"
#define _IFT_CBS_miflag "miflag"
 
namespace oofem {

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

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

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

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

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

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

class PressureLhsAssembler : 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 VelocityEquationNumbering : public UnknownNumberingScheme
{
protected:
    bool prescribed;
    int numEqs;
 
public:
    VelocityEquationNumbering(bool prescribed) : UnknownNumberingScheme(), prescribed(prescribed), numEqs(0) { }
 
    bool isDefault() const override { return !prescribed; }
    int giveDofEquationNumber(Dof *dof) const override {
        DofIDItem id = dof->giveDofID();
        if ( id == V_u || id == V_v || id == V_w ) {
            return prescribed ? dof->__givePrescribedEquationNumber() : dof->__giveEquationNumber();
        }
 
        return 0;
    }
    int giveRequiredNumberOfDomainEquation() const override { return numEqs; }
 
    int askNewEquationNumber() { return ++numEqs; }
};

class PressureEquationNumbering : public UnknownNumberingScheme
{
protected:
    bool prescribed;
    int numEqs;
 
public:
    PressureEquationNumbering(bool prescribed) : UnknownNumberingScheme(), prescribed(prescribed), numEqs(0) { }
 
    bool isDefault() const override { return !prescribed; }
    int giveDofEquationNumber(Dof *dof) const override {
        DofIDItem id = dof->giveDofID();
        if ( id == P_f ) {
            return prescribed ? dof->__givePrescribedEquationNumber() : dof->__giveEquationNumber();
        }
 
        return 0;
    }
    int giveRequiredNumberOfDomainEquation() const override { return numEqs; }
 
    int askNewEquationNumber() { return ++numEqs; }
};

class CBS : public FluidModel
{
protected:
    std :: unique_ptr< SparseLinearSystemNM > nMethod;
 
    LinSystSolverType solverType;
    SparseMtrxType sparseMtrxType;
 
    std :: unique_ptr< SparseMtrx > lhs;
    DofDistributedPrimaryField pressureField;
    DofDistributedPrimaryField velocityField;
    FloatArray deltaAuxVelocity;
    FloatArray prescribedTractionPressure;
    FloatArray nodalPrescribedTractionPressureConnectivity;

    FloatArray mm;
    std :: unique_ptr< SparseMtrx > mss;

    double deltaT, minDeltaT;
    double theta1, theta2;
 
    int initFlag;
    int consistentMassFlag;
 
    VelocityEquationNumbering vnum;
    VelocityEquationNumbering vnumPrescribed;
    PressureEquationNumbering pnum;
    PressureEquationNumbering pnumPrescribed;
 
    bool equationScalingFlag;
    double lscale;
    double uscale;
    double dscale;
    double Re;
 
    //<RESTRICTED_SECTION>
    // material interface representation for multicomponent flows
    std :: unique_ptr< MaterialInterface > materialInterface;
    //</RESTRICTED_SECTION>
public:
    CBS(int i, EngngModel * _master = NULL);
    virtual ~CBS();
 
    void solveYourselfAt(TimeStep *tStep) override;
 
    void updateYourself(TimeStep *tStep) override;
 
    int giveUnknownDictHashIndx(ValueModeType mode, TimeStep *tStep) override;
    double giveUnknownComponent(ValueModeType type, TimeStep *tStep, Domain *d, Dof *dof) override;
    bool newDofHandling() override { return true; }
    double giveReynoldsNumber() override;
    double giveTheta1();
    double giveTheta2();
    double giveTractionPressure(Dof *dof);
 
    void saveContext(DataStream &stream, ContextMode mode) override;
    void restoreContext(DataStream &stream, ContextMode mode) override;
 
    void updateDomainLinks() override;
 
    TimeStep *giveNextStep() override;
    TimeStep *giveSolutionStepWhenIcApply(bool force = false) override;
    NumericalMethod *giveNumericalMethod(MetaStep *mStep) override;
 
    void initializeFrom(InputRecord &ir) override;
 
    int checkConsistency() override;
    // identification
    const char *giveClassName() const override { return "CBS"; }
    const char *giveInputRecordName() const { return _IFT_CBS_Name; }
    fMode giveFormulation() override { return TL; }
 
    void printDofOutputAt(FILE *stream, Dof *iDof, TimeStep *tStep) override;
 
    int giveNumberOfDomainEquations(int, const UnknownNumberingScheme &num) override;
 
    int giveNewEquationNumber(int domain, DofIDItem) override;
    int giveNewPrescribedEquationNumber(int domain, DofIDItem) override;
 
    bool giveEquationScalingFlag() override { return equationScalingFlag; }
    double giveVariableScale(VarScaleType varId) override;
 
protected:
    void updateInternalState(TimeStep *tStep);
    void applyIC(TimeStep *tStep);
};
} // end namespace oofem
#endif // cbs_h