transienttransportproblem.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2013   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 transienttransportproblem_h
#define transienttransportproblem_h

#include "engngm.h"
#include "sparselinsystemnm.h"
#include "sparsemtrx.h"

#include <memory>


#define _IFT_TransientTransportProblem_Name "transienttransport"
#define _IFT_TransientTransportProblem_alpha "alpha" 
#define _IFT_TransientTransportProblem_deltaT "deltat" 
#define _IFT_TransientTransportProblem_dtFunction "dtfunction" 
#define _IFT_TransientTransportProblem_prescribedTimes "prescribedtimes" 
#define _IFT_TransientTransportProblem_keepTangent "keeptangent" 
#define _IFT_TransientTransportProblem_lumped "lumped" 
#define _IFT_TransientTransportProblem_exportFields "exportfields" 


namespace oofem {
class SparseNonLinearSystemNM;
class PrimaryField;
class Function;

class TransientTransportProblem : public EngngModel
{
protected:
    SparseMtrxType sparseMtrxType;
    std :: unique_ptr< PrimaryField > field;

    std :: unique_ptr< SparseMtrx > effectiveMatrix;

    FloatArray solution;
    FloatArray internalForces;
    FloatArray eNorm;

    std :: unique_ptr< SparseNonLinearSystemNM > nMethod;

    double alpha;
    int dtFunction;
    FloatArray prescribedTimes;
    double deltaT;
    bool keepTangent, hasTangent;
    bool lumped;

    IntArray exportFields;

public:
    TransientTransportProblem(int i, EngngModel * _master);
    virtual ~TransientTransportProblem();

    virtual void solveYourselfAt(TimeStep *tStep);
    virtual void updateComponent(TimeStep *tStep, NumericalCmpn cmpn, Domain *d);
    virtual double giveUnknownComponent(ValueModeType mode, TimeStep *tStep, Domain *d, Dof *dof);
    virtual contextIOResultType saveContext(DataStream &stream, ContextMode mode);
    virtual contextIOResultType restoreContext(DataStream &stream, ContextMode mode);
    
    virtual void applyIC();

    virtual int requiresUnknownsDictionaryUpdate();
    virtual int giveUnknownDictHashIndx(ValueModeType mode, TimeStep *tStep);
    virtual void updateDomainLinks();

    Function *giveDtFunction();
    double giveDeltaT(int n);
    double giveDiscreteTime(int iStep);

    virtual TimeStep *giveNextStep();
    virtual TimeStep *giveSolutionStepWhenIcApply(bool force = false);
    virtual NumericalMethod *giveNumericalMethod(MetaStep *mStep);

    virtual IRResultType initializeFrom(InputRecord *ir);

    virtual bool requiresEquationRenumbering(TimeStep *tStep);
    virtual int forceEquationNumbering();

    virtual void updateYourself(TimeStep *tStep);
    
    virtual int checkConsistency();
    virtual FieldPtr giveField (FieldType key, TimeStep *);
    // identification
    virtual const char *giveInputRecordName() const { return _IFT_TransientTransportProblem_Name; }
    virtual const char *giveClassName() const { return "TransientTransportProblem"; }
    virtual fMode giveFormulation() { return TL; }
};
} // end namespace oofem
#endif // transienttransportproblem_h