Helpers.h

Go to the documentation of this file.

//Copyright (c) 2013-2014, The MercuryDPM Developers Team. All rights reserved.
//For the list of developers, see <http://www.MercuryDPM.org/Team>.
//
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name MercuryDPM nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
//ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
//DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
//ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
//(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef HELPERS_H
#define HELPERS_H

#include "ExtendedMath.h"
#include <iostream> //std::istream and std::stringstream
#include <fstream> //std::fstream
#include <vector> //std::fstream
#include <Logger.h>
class ParticleSpecies;

namespace helpers
{

    class KAndDisp
    {
    public:
        Mdouble k;
        Mdouble disp;
    };

    MERCURY_DEPRECATED
    KAndDisp computeKAndDispFromCollisionTimeAndRestitutionCoefficientAndEffectiveMass(Mdouble tc, Mdouble r, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeCollisionTimeFromKAndDispAndEffectiveMass(Mdouble k, Mdouble disp, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeRestitutionCoefficientFromKAndDispAndEffectiveMass(Mdouble k, Mdouble disp, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeDispFromKAndRestitutionCoefficientAndEffectiveMass(Mdouble k, Mdouble r, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeCollisionTimeFromKAndRestitutionCoefficientAndEffectiveMass(Mdouble k, Mdouble r, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeDispFromKAndCollisionTimeAndEffectiveMass(Mdouble k, Mdouble tc, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeRestitutionCoefficientFromKAndCollisionTimeAndEffectiveMass(Mdouble k, Mdouble tc, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeDispFromCollisionTimeAndRestitutionCoefficientAndEffectiveMass(Mdouble tc, Mdouble r, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeKFromCollisionTimeAndRestitutionCoefficientAndEffectiveMass(Mdouble tc, Mdouble r, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeKFromCollisionTimeAndDispAndEffectiveMass(Mdouble tc, Mdouble disp, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeRestitutionCoefficientFromCollisionTimeAndDispAndEffectiveMass(Mdouble tc, Mdouble disp, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeKFromDispAndRestitutionCoefficientAndEffectiveMass(Mdouble disp, Mdouble r, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble computeCollisionTimeFromDispAndRestitutionCoefficientAndEffectiveMass(Mdouble disp, Mdouble r, Mdouble mass);


    class KAndDispAndKtAndDispt
    {
    public:
        Mdouble k;
        Mdouble disp;
        Mdouble kt;
        Mdouble dispt;
    };

    MERCURY_DEPRECATED
    KAndDispAndKtAndDispt computeDisptFromCollisionTimeAndRestitutionCoefficientAndTangentialRestitutionCoefficientAndEffectiveMass(Mdouble tc, Mdouble r, Mdouble beta, Mdouble mass);

    MERCURY_DEPRECATED
    Mdouble getMaximumVelocity(Mdouble k, Mdouble disp, Mdouble radius, Mdouble mass);

    unsigned int getSaveCountFromNumberOfSavesAndTimeMaxAndTimestep(unsigned int numberOfSaves, Mdouble timeMax, Mdouble timestep);

    void getLineFromStringStream(std::istream& in, std::stringstream& out);

    bool writeToFile(std::string filename, std::string filecontent);

    bool addToFile(std::string filename, std::string filecontent);

    bool fileExists(std::string strFilename);

    bool openFile(std::fstream& file, std::string filename, std::fstream::openmode mode);

    Mdouble getEffectiveMass(Mdouble mass0, Mdouble mass1);

    std::vector<double> readArrayFromFile(std::string filename, int& n, int& m);

    template < typename T > std::string to_string( const T& n )
    {
        std::ostringstream stm ;
        stm << n ;
        return stm.str() ;
    }

    //reads optional variables in the restart file (a variable is optional, if it may or may not be defined in the restart file)
    template < typename T >
    void readOptionalVariable(std::istream& is,std::string name, T& variable) {
        if (is.peek() == name.c_str()[0]) 
        {
            std::string dummy;
            is >> dummy >> variable;
        }
    }

    void loadingTest(const ParticleSpecies* species, Mdouble displacement, Mdouble velocity, Mdouble radius, std::string name);

    void normalAndTangentialLoadingTest(const ParticleSpecies *species, Mdouble displacement,
                                        Mdouble tangentialDisplacement, Mdouble velocity, Mdouble radius,
                                        std::string name);

    void objectivenessTest(const ParticleSpecies* species, Mdouble displacement, Mdouble tangentialDisplacement, Mdouble velocity, Mdouble radius, std::string name);

    template < typename T >
    T readFromFile(std::string fileName, std::string varName, T value) {
        //open filestream
        std::ifstream is(fileName.c_str(), std::ios::in);
        if (is.fail()) {
            logger(INFO, "readFromFile: file % could not be opened, variable % set to default value %", fileName, varName, value);
            return value;
        }

        //read in variables, until the right one is fount
        std::string s;
        while(!is.eof()) {
            is >> s;
            if (!s.compare(varName)) {
                is >> value;
                logger(INFO,"readFromFile: variable % set to % ",varName,value);
                return value;
            }
        }

        //if the right variable is never found
        logger(WARN,"readFromFile: variable % not set in file %, set to default value % ", varName, fileName, value);
        return value;
    }

    bool compare(std::istream& is,std::string s);

    void check (double real, double ideal, double error, std::string errorMessage);
}

#endif