Parameter study in 2D parameter space

Problem description

This tutorial is an extension to ParameterStudy1DDemo, and thus also has very similar code structure. It shows how to do a parameter study by using the DPMBase::autonumber function in DPMBase. This tutorial treats the case in which a 2D parameter study has to be performed. The difference with ParameterStudy1DDemo is only the addition of the second dimension of the parameter study. Only the differences with respect to the 1D case are given here, as it is assumed that one looks at ParameterStudy1DDemo first. In this case ParameterStudy1D is extended to change both particle radii, and thus a parameter space can be created. This parameter space is also visualised in the image below.

Schematic overview of a 2D parameter study. Definitions of i, j, dim1 and dim2 will be given later.

Headers

The following headers are included:

#include "Mercury3D.h"
#include "Math/Helpers.h"
#include "Species/LinearViscoelasticFrictionSpecies.h"
#include <iostream>
#include <vector>

These are the headers needed for this tutorial.

Before the main function

The main class inherits from Mercury3D.

class ParameterStudy2DDemo : public Mercury3D 

All steps needed in order to create this class have been explained below.
Step 1: (Private) Member variables.
Compared to ParameterStudy1DDemo a new variable is added, dim2_, that stores the information of the second dimension of the parameter study. Furthermore the size of studyNum is now also incremented by 1, as it stores information of both dimensions. studyNum is now build up as follows: The first entry is (still) storing an integer value giving information of the completeness of the study. The second and third entry store the current run in the first and second dimension respectively.

    int dim1_ = 0;
    int dim2_ = 0;
    std::vector<int> studyNum;

Step 2: Set- and Get-functions for private member variables.
The set- and get-functions are extended to incorporate the second dimension with respect to ParameterStudy1DDemo.

    void setStudyDimensions(int dim1, int dim2)
    {
        dim1_ = dim1;
        dim2_ = dim2;
    }
 
    std::vector<int> getCurrentStudyNum()
    {
        return DPMBase::get2DParametersFromRunNumber(dim1_,dim2_);
    }

Step 3: Create the particle species.
Nothing changed with respect to ParameterStudy1DDemo

Step 4: Setup the initial conditions.
The only change with respect to ParameterStudy2DDemo is that now the second particle is dependent on the second dimension of the parameter study.

    void setupInitialConditions() override
    {
        studyNum = getCurrentStudyNum();
        createSpecies();
 
        SphericalParticle P;
        P.setSpecies(speciesHandler.getObject(0));
        // Create 2 particles
        particleHandler.copyAndAddObject(P);
        particleHandler.copyAndAddObject(P);
        //Set up the stuff that is the same for all runs
        particleHandler.getObject(0)->setPosition(Vec3D(0.006,0.005,0.0));
        particleHandler.getObject(1)->setPosition(Vec3D(0.004,0.005,0.0));
        particleHandler.getObject(0)->setVelocity(Vec3D(-0.1,0.0,0.0));
        particleHandler.getObject(1)->setVelocity(Vec3D( 0.1,0.0,0.0));
        // We have two different size particles for both left and right particles
        // The value gets updated based on what studyNum is, these come from the automatic counter
        particleHandler.getObject(0)->setRadius(0.0001*studyNum[1]);
        particleHandler.getObject(1)->setRadius(0.0001*studyNum[2]);
    }

Step 5: Setting up the parameter study.
Nothing changed with respect to ParameterStudy1DDemo, both actionsBeforeTimeLoop() and actionsAfterSolve() are the same.

Step 6: Creating the main function.
The only difference with ParameterStudy2DDemo is that now both study dimensions have to be set.

problem.setStudyDimensions(2,2) 

This line results in 4 simulations being run, in which all 4 combinations of particle sizes are solved.

int main(int argc UNUSED, char *argv[] UNUSED)
{
    //Problem constructor, using class definition above
    ParameterStudy2DDemo problem;
    // Setup the study dimensions that you want to perform
    problem.setStudyDimensions(2,2);
    // Setup the automatic numbering system (create/read COUNTER_DO_NOT_DEL file)
    problem.autoNumber();
    // Setup output file name
    problem.setName("ParameterStudy2DDemo");
    // General simulation settings
    problem.setTimeStep(1e-5);
    problem.setTimeMax(0.1);
    problem.setSaveCount(5000);
    problem.setXMin(0.0);
    problem.setXMax(1.0);
    problem.setYMin(0.0);
    problem.setYMax(1.0);
    problem.setZMin(0.0);
    problem.setZMax(1.0);
 
    // Solve the problem
    problem.solve();
    // Give a successful exit code to the terminal
    return 0;
}

If you would like to look at the 1D or 3D parameter study demos:
ParameterStudy1DDemo
ParameterStudy3DDemo
Or return to Overview of advanced tutorials