MercuryCG.cpp File Reference

#include <Mercury3D.h>
#include <CG/CG.h>
#include <CG/TimeSmoothedCG.h>
#include <CG/TimeAveragedCG.h>
#include <CG/Functions/Linear.h>
#include <CG/Fields/GradVelocityField.h>
#include <CG/Fields/LiquidMigrationFields.h>
#include <CG/Fields/OrientationField.h>
#include <algorithm>
#include <Interactions/AdhesiveForceInteractions/LiquidMigrationWilletInteraction.h>
#include <cstring>

Functions
template<template< class, template< class > class, class > class CGType, template< class > class BaseFunction, class Fields >
void	addObject (CGHandler &cg, std::string coordinate)
template<template< class > class BaseFunction, class Fields >
void	addObject (CGHandler &cg, std::string typeOrig, std::string coordinate)
template<class Fields >
void	addObject (CGHandler &cg, std::string type, std::string coordinate, std::string function)
BaseCG *	addObject (CGHandler &cg, std::string type, std::string coordinate, std::string function, std::string fieldsOrig)
void	commandLineCG (Mercury3D &dpm, int argc, char **argv)
int	main (int argc, char *argv[])
	MercuryCG is the postprocessing tool for extracting coarse-grained fields from particle data. See MercuryCG: Post-processing discrete particle data using the coarse-graining formulation (in development) for details. More...

Function Documentation

addObject() [1/4]

template<template< class, template< class > class, class > class CGType, template< class > class BaseFunction, class Fields >

void addObject	(	CGHandler &	cg,
		std::string	coordinate
	)

                                                    {
    if (coordinate == "O") {
        cg.copyAndAddObject(CGType<CGCoordinates::O, BaseFunction, Fields>());
    } else if (coordinate == "X") {
        cg.copyAndAddObject(CGType<CGCoordinates::X, BaseFunction, Fields>());
    } else if (coordinate == "Y") {
        cg.copyAndAddObject(CGType<CGCoordinates::Y, BaseFunction, Fields>());
    } else if (coordinate == "Z") {
        cg.copyAndAddObject(CGType<CGCoordinates::Z, BaseFunction, Fields>());
    } else if (coordinate == "XY") {
        cg.copyAndAddObject(CGType<CGCoordinates::XY, BaseFunction, Fields>());
    } else if (coordinate == "XZ") {
        cg.copyAndAddObject(CGType<CGCoordinates::XZ, BaseFunction, Fields>());
    } else if (coordinate == "YZ") {
        cg.copyAndAddObject(CGType<CGCoordinates::YZ, BaseFunction, Fields>());
    } else if (coordinate == "XYZ") {
        cg.copyAndAddObject(CGType<CGCoordinates::XYZ, BaseFunction, Fields>());
    } else {
        logger(ERROR, "CGCoordinate % not understood; options are O,X,Y,Z,XY,XZ,YZ,XYZ", coordinate);
    }
}

References ERROR, and logger.

Referenced by commandLineCG(), BaseHandler< T >::copyAndAddObject(), BaseHandler< T >::copyContentsFromOtherHandler(), and RotatingDrum::setupInitialConditions().

addObject() [2/4]

template<class Fields >

void addObject	(	CGHandler &	cg,
		std::string	type,
		std::string	coordinate,
		std::string	function
	)

                                                                                        {
    if (function == "Gauss") {
        addObject<CGFunctions::Gauss, Fields>(cg, type, coordinate);
    } else if (function == "Lucy") {
        addObject<CGFunctions::Lucy, Fields>(cg, type, coordinate);
    } else if (function == "Linear") {
        addObject<CGFunctions::Linear, Fields>(cg, type, coordinate);
    } else if (function == "Heaviside") {
        addObject<CGFunctions::Heaviside, Fields>(cg, type, coordinate);
    } else {
        logger(ERROR, "CGFunction % not understood; options are Gauss, Lucy, Linear, Heaviside", function);
    }
}

References ERROR, and logger.

addObject() [3/4]

BaseCG* addObject	(	CGHandler &	cg,
		std::string	type,
		std::string	coordinate,
		std::string	function,
		std::string	fieldsOrig
	)

Creates a CG-object with the template parameters and parent class specified by string arguments. The object is added to the cgHandler and a BaseCG pointer to it is returned. To obtain the right template parameters from the string arguments, a cascade of 4 functions is used (see above). Each function expresses one of the strings to a tempate parameter.

                                                                                                                 {
    //change strings to lower case
    std::string fields = fieldsOrig;
    std::transform(fields.begin(), fields.end(), fields.begin(), ::tolower);
    if (fields == "standardfields" || fields == "standard") {
        addObject<CGFields::StandardFields>(cg, type, coordinate, function);
    } else if (fields == "gradvelocityfield" || fields == "gradvelocity") {
        addObject<CGFields::GradVelocityField>(cg, type, coordinate, function);
    } else if (fields == "liquidmigrationfields" || fields == "liquidmigration") {
        addObject<CGFields::LiquidMigrationFields>(cg, type, coordinate, function);
    } else {
        logger(ERROR, "CGFields % not understood; options are standard, gradVelocity, liquidMigration ", fieldsOrig);
    }
    return cg.getLastObject();
}

References ERROR, BaseHandler< T >::getLastObject(), and logger.

addObject() [4/4]

template<template< class > class BaseFunction, class Fields >

void addObject	(	CGHandler &	cg,
		std::string	typeOrig,
		std::string	coordinate
	)

                                                                        {
    std::string type = typeOrig;
    std::transform(type.begin(), type.end(), type.begin(), ::tolower);
    if (type == "cg") {
        addObject<CG, BaseFunction, Fields>(cg, coordinate);
    } else if (type == "timesmoothedcg") {
        addObject<TimeSmoothedCG, BaseFunction, Fields>(cg, coordinate);
    } else if (type == "timeaveragedcg") {
        addObject<TimeAveragedCG, BaseFunction, Fields>(cg, coordinate);
    } else {
        logger(ERROR, "CGType % not understood; options are CG, TimeSmoothedCG, TimeAveragedCG", typeOrig);
    }
}

References ERROR, and logger.

commandLineCG()

void commandLineCG	(	Mercury3D &	dpm,
		int	argc,
		char **	argv
	)

Creates an object in the cgHandler of the dpm class that satisfies the options specified by the command line arguments.

First, it checks if -help was specified. In this case, the help file is displayed, and the program exits.

Second, the correct type of CG object is determined, based on the following command line arguments: name, -coordinate, -function, -fields, -timeaverage, -timesmooth

Third, all other command line arguments are read and passed into the CG object.

{
    //change options to lower case
    for (unsigned i = 2; i < argc; i++) {
        if (argv[i][0] == '-')
            for (unsigned j = 1; j < strlen(argv[i]); ++j) {
                argv[i][j] = tolower(argv[i][j]);
            }
    }
 
    //checks if if -help option was requested
    for (unsigned i = 1; i < argc; i++)
        if (!strcmp(argv[i], "-help")) {
            helpers::more(std::string(argv[0]) + ".txt");
            exit(-1);
        }
 
    //coordinate
    //Stores the CGCoordinate type.
    //This variable is a template parameter of CG and needs to be specified by the argument -stattype
    //If unspecified, it is set to default value O.
    std::string coordinate = "O";
    for (unsigned i = 1; i < argc; i++)
        if (!strcmp(argv[i], "-coordinates") || !strcmp(argv[i], "-stattype")) {
            coordinate = argv[i + 1];
            logger(INFO, "Set CGCoordinates to %", coordinate);
        }
 
    //function
    //Stores the CGFunction type.
    //This variable is a template parameter of CG and needs to be specified by the argument -cgtype
    //If unspecified, it is set to default value Lucy.
    std::string function = "Lucy";
    for (unsigned i = 1; i < argc; i++)
        if (!strcmp(argv[i], "-function") || !strcmp(argv[i], "-cgtype")) {
            function = argv[i + 1];
            logger(INFO, "Set CGFunction to %", function);
        }
 
    //fields
    //Stores the CGField type.
    //This variable is a template parameter of CG and needs to be specified by the argument -function
    //If unspecified, it is set to default value Standard.
    std::string fields = "StandardFields";
    for (unsigned i = 1; i < argc; i++)
        if (!strcmp(argv[i], "-fields")) {
            fields = argv[i + 1];
            logger(INFO, "Set CGFields to %", fields);
        }
 
    //type
    //Determines the CG type (CG or TimeAveragedCG)
    //It needs to be specified by the argument -timeAverage
    //If unspecified, it is set to default value 'false'.
    // take the 'T' off the coordinate name if time averaged
    std::string type = "CG";
    if (coordinate[0] == 'T') {
        type = "TimeSmoothedCG";
        coordinate = coordinate.substr(1);
    }
    for (unsigned i = 1; i < argc; i++)
        if (!strcmp(argv[i], "-timeaverage")) {
            type = "TimeAveragedCG";
            logger(INFO, "Creating time-averaged CG");
        } else if (!strcmp(argv[i], "-timeaveraging")) {
            logger(ERROR, "% is not a valid argument; use -timeaverage instead",argv[i]);
        }
    for (unsigned i = 1; i < argc; i++)
        if (!strcmp(argv[i], "-timesmooth")) {
            type = "TimeSmoothedCG";
            logger(INFO, "Activating time smoothing");
        }
 
    //Now create the right CG object and a pointer to it
    BaseCG *cg = addObject(dpm.cgHandler, type, coordinate, function, fields);
 
    //Reads the name of the file name to be restarted.
    //This variable needs to be specified as the second argument ("./MercuryCG name ...")
    //If unspecified, it is set to default value "Chain".
    std::string name;
    if (argc > 1 && argv[1][0] != '-') {
        name = argv[1];
        //logger(INFO, "Evaluating files %.*", name);
    }
    if (name.empty()) {
        logger(ERROR, "Please enter a base name base name of the files to be analysed.\n"
                      "For more information, enter './MercuryCG -help'");
    }
 
    //restarting from file
    dpm.cgHandler.restart(name);
 
    //make sure no data is written; if data is written (e.g. using the -writedata option, the files will be overwritten, not appended)
    //dpm.setFileType(FileType::NO_FILE);
    dpm.setAppend(false);
 
    //set a default stat file name
    cg->statFile.setName(dpm.getName() + ".stat");
 
    //set min/max, so h can be set
    cg->setMin(dpm.getMin());
    cg->setMax(dpm.getMax());
 
    // Now all other arguments are read
    // find first argument that begins with '-'
    unsigned i = 1;
    while (i < argc && argv[i][0] != '-') i++;
    //logger(INFO, "Reading argument % of %", i, argc);
    // interpret arguments
    for (; i < argc; i += 2) {
        if (!strcmp(argv[i], "-w") || !strcmp(argv[i], "-width")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setWidth(atof(argv[i + 1]));
            logger(INFO, "Set cg width to %", cg->getWidth());
//        } else if (!strcmp(argv[i], "-wt") || !strcmp(argv[i], "-widthTime")) {
//            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
//            auto cgs = dynamic_cast<TimeSmoothedCG>(cg);
//            cgs->setWidthTime(atof(argv[i + 1]));
//            logger(INFO, "Set cg width to %", cg->getWidth());
        } else if (!strcmp(argv[i], "-std")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setStandardDeviation(atof(argv[i + 1]));
            logger(INFO, "Set cg width to % (std %)", cg->getWidth(),atof(argv[i + 1]));
        } else if (!strcmp(argv[i], "-verbose")) {
            cg->setVerbose(true);
            logger(INFO, "Verbose output");
            ++i;
        } else if (!strcmp(argv[i], "-averagebeyonddomain")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setAverageBeyondDomain(atoi(argv[i + 1]));
            logger(INFO, "Set averageBeyondDomain to %", argv[i + 1]);
        } else if (!strcmp(argv[i], "-n")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setN(atoi(argv[i + 1]));
            logger(INFO, "Set n to %", argv[i + 1]);
        } else if (!strcmp(argv[i], "-nx")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setNX(atoi(argv[i + 1]));
            logger(INFO, "Set nx to %", argv[i + 1]);
        } else if (!strcmp(argv[i], "-ny")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setNY(atoi(argv[i + 1]));
            logger(INFO, "Set ny to %", argv[i + 1]);
        } else if (!strcmp(argv[i], "-nz")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setNZ(atoi(argv[i + 1]));
            logger(INFO, "Set nz to %", argv[i + 1]);
        } else if (!strcmp(argv[i], "-h")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setH(atof(argv[i + 1]));
            logger(INFO, "Set n to %x%x% for h=%", cg->getNX(), cg->getNY(), cg->getNZ(), argv[i + 1]);
        } else if (!strcmp(argv[i], "-hx")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setHX(atof(argv[i + 1]));
            logger(INFO, "Set nx to % to satisfy hx=%", cg->getNX(), argv[i + 1]);
        } else if (!strcmp(argv[i], "-hy")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setHY(atof(argv[i + 1]));
            logger(INFO, "Set ny to % to satisfy hy=%", cg->getNY(), argv[i + 1]);
        } else if (!strcmp(argv[i], "-hz")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setHZ(atof(argv[i + 1]));
            logger(INFO, "Set nz to % to satisfy hz=%", cg->getNZ(), argv[i + 1]);
        } else if (!strcmp(argv[i], "-x")) {
            logger.assert_debug(i+2<argc,"% requires two arguments",argv[i]);
            cg->setX(atof(argv[i + 1]), atof(argv[i + 2]));
            logger(INFO, "Set x to (%,%)", argv[i + 1], argv[i + 2]);
            ++i;
        } else if (!strcmp(argv[i], "-y")) {
            logger.assert_debug(i+2<argc,"% requires two arguments",argv[i]);
            cg->setY(atof(argv[i + 1]), atof(argv[i + 2]));
            logger(INFO, "Set y to (%,%)", argv[i + 1], argv[i + 2]);
            ++i;
        } else if (!strcmp(argv[i], "-z")) {
            logger.assert_debug(i+2<argc,"% requires two arguments",argv[i]);
            cg->setZ(atof(argv[i + 1]), atof(argv[i + 2]));
            logger(INFO, "Set z to (%,%)", argv[i + 1], argv[i + 2]);
            ++i;
        } else if (!strcmp(argv[i], "-t")) {
            logger.assert_debug(i+2<argc,"% requires two arguments",argv[i]);
            cg->setTimeMin(atof(argv[i + 1]));
            cg->setTimeMax(atof(argv[i + 2]));
            logger(INFO, "Set t to (%,%)", argv[i + 1], argv[i + 2]);
            i++;
        } else if (!strcmp(argv[i], "-savecount")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->statFile.setSaveCount(atof(argv[i + 1]));
            logger(INFO, "Set savecount to %", argv[i + 1]);
        } else if (!strcmp(argv[i], "-writedata")) {
            dpm.dataFile.setFileType(FileType::ONE_FILE);
            logger(INFO, "Turn on data file output. Execute %.xballs to visualise output", dpm.getName());
            --i;
        } else if (!strcmp(argv[i], "-tmin")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setTimeMin(atof(argv[i + 1]));
            logger(INFO, "Set tMin to %", argv[i + 1]);
        } else if (!strcmp(argv[i], "-timemin")) {
            logger(ERROR, "% is not a valid argument; use -tMin instead",argv[i]);
        } else if (!strcmp(argv[i], "-tmax")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->setTimeMax(atof(argv[i + 1]));
            logger(INFO, "Set tMax to %", argv[i + 1]);
        } else if (!strcmp(argv[i], "-dt")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            dpm.setTimeMax(dpm.getTime()+atof(argv[i + 1]));
            logger(INFO, "Set evaluation time interval to %", argv[i + 1]);
        } else if (!strcmp(argv[i], "-initialfilecounter")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            dpm.cgHandler.setInitialFileCounter(atoi(argv[i+1]));
            logger(INFO, "Initial file counter set to %", argv[i + 1]);
        } else if (!strcmp(argv[i], "-timemax")) {
            logger(ERROR, "% is not a valid argument; use -tMax instead",argv[i]);
        } else if (!strcmp(argv[i], "-species")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->selectSpecies(atoi(argv[i + 1]));
            logger(INFO, "Evaluating species #%", atoi(argv[i + 1]));
        } else if (!strcmp(argv[i], "-o")) {
            logger.assert_always(i+1<argc,"% requires argument",argv[i]);
            cg->statFile.setName(argv[i + 1]);
            logger(INFO, "Set output file name to %", argv[i + 1]);
        } else if (!strcmp(argv[i], "-coordinates") || !strcmp(argv[i], "-stattype") || !strcmp(argv[i], "-cgtype") || !strcmp(argv[i], "-function") || !strcmp(argv[i], "-fields") || !strcmp(argv[i], "-restartandanalyse")) {
            //these are commands with one argument that should be ignored here because they are read somewhere else
        } else if (!strcmp(argv[i], "-help") || !strcmp(argv[i], "-readfromrestart") || !strcmp(argv[i], "-timeaverage") || !strcmp(argv[i], "-timesmooth")) {
            //these are commands with no argument that should be ignored here because they are read somewhere else
            --i;
        } else if (!strcmp(argv[i], "-timeaveragereset")) {
            //these are commands with no argument that should be ignored here because they are read somewhere else
            logger(WARN, "This fstatistics command has no equivalent yet in MercuryCG and will be ignored: %", argv[i]);
        } else {
            logger(ERROR, "Could not read argument %", argv[i]);
        }
    }
 
    logger(INFO, "Created object of type %", cg->getName());
 
    dpm.readSpeciesFromDataFile();
 
    //Determine what kind of input to read from (data files, restart files, or live cg)
    //Variable that stores the type of data source
    enum class DataSource {
        readFromData,
        readFromRestart,
        restartAndAnalyse
    } dataSource = DataSource::readFromData;
    //read command line arguments to determine dataSource
    for (unsigned i = 1; i < argc; i++) {
        if (!strcmp(argv[i], "-readfromrestart")) {
            dataSource = DataSource::readFromRestart;
        } else if (!strcmp(argv[i], "-restartandanalyse")) {
            dataSource = DataSource::restartAndAnalyse;
            dpm.setTimeMax(dpm.getTime()+atof(argv[i+1]));
        }
    }
    //Evaluate based on dataSource
    if (dataSource == DataSource::readFromData) {
        logger(INFO, "Reading from data files.");
        if (!dpm.cgHandler.evaluateDataFiles()) {
            logger(ERROR,"Evaluation of data files has failed. Check input files.");
        }
    } else if (dataSource == DataSource::readFromRestart){
        logger(INFO, "Reading from restart files.");
        if (dpm.restartFile.getFileType()!=FileType::MULTIPLE_FILES &&
            dpm.restartFile.getFileType()!=FileType::MULTIPLE_FILES_PADDED) {
            logger(ERROR,"Evaluation of restart files requires multiple restart files. Check input.");
        }
        dpm.cgHandler.evaluateRestartFiles();
    } else {
        logger(INFO,"Restarting simulation for live analysis");
        //dpm.write(std::cout,false);
        //dpm.setSaveCount(25);
        dpm.solve();
    }
    logger(INFO, "\n"
                 "MercuryCG has finished.\n"
                 "Coarse-grained output is written to %\n"
                 "To load output into Matlab, use data=readMercuryCG('%')",
           dpm.cgHandler.getLastObject()->statFile.getName(), dpm.cgHandler.getLastObject()->statFile.getName());
}

References addObject(), DPMBase::cgHandler, DPMBase::dataFile, ERROR, CGHandler::evaluateDataFiles(), CGHandler::evaluateRestartFiles(), File::getFileType(), BaseHandler< T >::getLastObject(), DPMBase::getMax(), DPMBase::getMin(), DPMBase::getName(), File::getName(), BaseObject::getName(), BaseCG::getNX(), BaseCG::getNY(), BaseCG::getNZ(), DPMBase::getTime(), BaseCG::getWidth(), constants::i, INFO, logger, helpers::more(), MULTIPLE_FILES, MULTIPLE_FILES_PADDED, units::name, ONE_FILE, DPMBase::readSpeciesFromDataFile(), CGHandler::restart(), DPMBase::restartFile, BaseCG::selectSpecies(), DPMBase::setAppend(), BaseCG::setAverageBeyondDomain(), File::setFileType(), BaseCG::setH(), BaseCG::setHX(), BaseCG::setHY(), BaseCG::setHZ(), CGHandler::setInitialFileCounter(), BaseCG::setMax(), BaseCG::setMin(), BaseCG::setN(), File::setName(), BaseCG::setNX(), BaseCG::setNY(), BaseCG::setNZ(), File::setSaveCount(), BaseCG::setStandardDeviation(), DPMBase::setTimeMax(), BaseCG::setTimeMax(), BaseCG::setTimeMin(), BaseCG::setVerbose(), BaseCG::setWidth(), BaseCG::setX(), BaseCG::setY(), BaseCG::setZ(), DPMBase::solve(), BaseCG::statFile, and WARN.

Referenced by main().

main()

int main	(	int argc	,
		char *	argv[]
	)

MercuryCG is the postprocessing tool for extracting coarse-grained fields from particle data. See MercuryCG: Post-processing discrete particle data using the coarse-graining formulation (in development) for details.

                                 {
    Mercury3D dpm;
    commandLineCG(dpm, argc, argv);
    return 0;
}

References commandLineCG().