Codes for tutorials

Particle motion in outer space (code)

Return to tutorial T1: Particle motion in outer space

//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.

// Tutorial 1

/*
** This file is annotated with DoxyFile comments in order to show the code on
** the documentation - This is not needed for your real drivers.
** Please ignore these comments.
*/

#include <Species/Species.h>
#include <Species/LinearViscoelasticSpecies.h>
#include <Mercury3D.h>
#include <Particles/BaseParticle.h>

class Tutorial1 : public Mercury3D  
{ 

  public:

  void setupInitialConditions()
  { 
    BaseParticle p0;
    p0.setSpecies(speciesHandler.getObject(0));
    p0.setRadius(0.05); // sets particle radius
    p0.setPosition(Vec3D(0.1*getXMax(),0.1*getYMax(),0.1*getZMax())); // sets particle position
    p0.setVelocity(Vec3D(0.5,0.1,0.1));
    particleHandler.copyAndAddObject(p0);
  }
};

int main(int argc, char *argv[])
{
  // Problem setup
  Tutorial1 problem;

  problem.setName("Tutorial1");
  problem.setSystemDimensions(3);
  problem.setGravity(Vec3D(0.0,0.0,0.0));
  problem.setXMax(1.0);
  problem.setYMax(1.0);
  problem.setZMax(1.0);
  problem.setTimeMax(2.0);

  // The normal spring stiffness and normal dissipation is computed and set as 
  // For collision time tc=0.005 and restitution coefficeint rc=1.0,
  auto species = problem.speciesHandler.copyAndAddObject(LinearViscoelasticSpecies());
  species->setDensity(2500.0); // sets the species type-0 density
  species->setStiffness(258.5);// sets the spring stiffness
  species->setDissipation(0.0);// sets the dissipation

  problem.setSaveCount(10);
  problem.dataFile.setFileType(FileType::ONE_FILE);
  problem.restartFile.setFileType(FileType::ONE_FILE);
  problem.fStatFile.setFileType(FileType::NO_FILE);
  problem.eneFile.setFileType(FileType::NO_FILE);
  std::cout << problem.dataFile.getCounter() << std::endl;

  problem.setXBallsAdditionalArguments("-solidf -v0");

  problem.setTimeStep(.005/50.0); // (collision time)/50.0
  problem.solve(argc, argv);
  return 0;
}

Return to tutorial T1: Particle motion in outer space

Particle motion on earth (code)

Return to tutorial T2: Particle motion on earth

//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.

// Tutorial 2

/*
** This file is annotated with DoxyFile comments in order to show the code on
** the documentation - This is not needed for your real drivers.
** Please ignore these comments.
*/

#include <Species/LinearViscoelasticSpecies.h>
#include <Mercury3D.h>
#include <Particles/BaseParticle.h>

class Tutorial2 : public Mercury3D
{
  public:

  void setupInitialConditions()
  { 
    BaseParticle p0;
    p0.setSpecies(speciesHandler.getObject(0));
    p0.setRadius(0.05);
    p0.setPosition(Vec3D(0.5*getXMax(),0.5*getYMax(),getZMax()));
    p0.setVelocity(Vec3D(0.0,0.0,0.0));
    particleHandler.copyAndAddObject(p0);
  }

};

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

  // Problem setup
  Tutorial2 problem;

  problem.setName("Tutorial2");
  problem.setSystemDimensions(3);
  problem.setGravity(Vec3D(0.0,0.0,-9.81));
  problem.setXMax(1.0);
  problem.setYMax(1.0);
  problem.setZMax(5.0);
  problem.setTimeMax(1.5);

  // The normal spring stiffness and normal dissipation is computed and set as 
  // For collision time tc=0.005 and restitution coefficeint rc=1.0, 
  auto species = problem.speciesHandler.copyAndAddObject(LinearViscoelasticSpecies());
  species->setDensity(2500.0); // sets the species type-0 density
  species->setStiffness(258.5);// sets the spring stiffness
  species->setDissipation(0.0);// sets the dissipation

  problem.setSaveCount(10);
  problem.dataFile.setFileType(FileType::ONE_FILE);
  problem.restartFile.setFileType(FileType::ONE_FILE);
  problem.fStatFile.setFileType(FileType::NO_FILE);
  problem.eneFile.setFileType(FileType::NO_FILE);

  problem.setXBallsAdditionalArguments("-solidf -v0");  

  problem.setTimeStep(.005/50.0);// (collision time)/50.0
  problem.solve(argc, argv);
  
  return 0;
}

Return to tutorial T2: Particle motion on earth

Bouncing ball - elastic (code)

Return to tutorial T3: Bouncing ball (elastic)

//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.

// Tutorial 3

/*
** This file is annotated with DoxyFile comments in order to show the code on
** the documentation - This is not needed for your real drivers.
** Please ignore these comments.
*/

#include <Species/LinearViscoelasticSpecies.h>
#include <Mercury3D.h>
#include <Particles/BaseParticle.h>
#include <Walls/InfiniteWall.h>

class Tutorial3 : public Mercury3D
{
  public:

  void setupInitialConditions()
  { 
    BaseParticle p0;
    p0.setSpecies(speciesHandler.getObject(0));
    p0.setRadius(0.005);
    p0.setPosition(Vec3D(0.5*getXMax(),0.5*getYMax(),getZMax()));
    p0.setVelocity(Vec3D(0.0,0.0,0.0));
    particleHandler.copyAndAddObject(p0);

    InfiniteWall w0;
    w0.setSpecies(speciesHandler.getObject(0));
    w0.set(Vec3D(0.0,0.0,-1.0),Vec3D(0, 0, getZMin()));
    wallHandler.copyAndAddObject(w0);
  }

};

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

  // Problem setup
  Tutorial3 problem;

  problem.setName("Tutorial3");
  problem.setSystemDimensions(3);
  problem.setGravity(Vec3D(0.0,0.0,-9.81));
  problem.setXMax(1.0);
  problem.setYMax(1.0);
  problem.setZMax(2.0);
  problem.setTimeMax(5.0);

  // The normal spring stiffness and normal dissipation is computed and set as 
  // For collision time tc=0.005 and restitution coefficeint rc=1.0, 
  auto species = problem.speciesHandler.copyAndAddObject(LinearViscoelasticSpecies());
  species->setDensity(2500.0); // sets the species type-0 density
  species->setStiffness(258.5);// sets the spring stiffness
  species->setDissipation(0.0);// sets the dissipation

  problem.setSaveCount(10);
  problem.dataFile.setFileType(FileType::ONE_FILE);
  problem.restartFile.setFileType(FileType::ONE_FILE);
  problem.fStatFile.setFileType(FileType::NO_FILE);
  problem.eneFile.setFileType(FileType::NO_FILE);

  problem.setXBallsAdditionalArguments("-solidf -v0");  

  problem.setTimeStep(0.005/50.0); // (collision time)/50.0
  problem.solve(argc, argv);

  return 0;
}

Return to tutorial T3: Bouncing ball (elastic)

Bouncing ball - inelastic (code)

Return to tutorial T4: Bouncing ball with dissipation (inelastic)

//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.

// Tutorial 4

/*
** This file is annotated with DoxyFile comments in order to show the code on
** the documentation - This is not needed for your real drivers.
** Please ignore these comments.
*/

#include <Species/LinearViscoelasticSpecies.h>
#include <Mercury3D.h>
#include <Particles/BaseParticle.h>
#include <Walls/InfiniteWall.h>

class Tutorial4 : public Mercury3D
{
  public:

  void setupInitialConditions()
  { 
    BaseParticle p0;
    p0.setSpecies(speciesHandler.getObject(0));
    p0.setRadius(0.005);
    p0.setPosition(Vec3D(0.5*getXMax(),0.5*getYMax(),getZMax()));
    p0.setVelocity(Vec3D(0.0,0.0,0.0));
    particleHandler.copyAndAddObject(p0);

    InfiniteWall w0;
    w0.setSpecies(speciesHandler.getObject(0));
    w0.set(Vec3D(0.0,0.0,-1.0),Vec3D(0.0,0.0,getZMin()));
    wallHandler.copyAndAddObject(w0);
  }

};

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

  // Problem setup
  Tutorial4 problem;

  problem.setName("Tutorial4");
  problem.setSystemDimensions(3);
  problem.setGravity(Vec3D(0.0,0.0,-9.81));
  problem.setXMax(1.0);
  problem.setYMax(1.0);
  problem.setZMax(2.0);
  problem.setTimeMax(5.0);

  // The normal spring stiffness and normal dissipation is computed and set as 
  // For collision time tc=0.005 and restitution coefficeint rc=0.88, 
  auto species = problem.speciesHandler.copyAndAddObject(LinearViscoelasticSpecies());
  species->setDensity(2500.0); // sets the species type-0 density
  species->setStiffness(259.0159);// sets the spring stiffness
  species->setDissipation(0.0334);// sets the dissipation

  problem.setSaveCount(10);
  problem.dataFile.setFileType(FileType::ONE_FILE);
  problem.restartFile.setFileType(FileType::ONE_FILE);
  problem.fStatFile.setFileType(FileType::NO_FILE);
  problem.eneFile.setFileType(FileType::NO_FILE);

  problem.setXBallsAdditionalArguments("-solidf -v0");  

  problem.setTimeStep(0.005/50.0); // (collision time)/50.0
  problem.solve(argc, argv);

  return 0;
}

Return to tutorial T4: Bouncing ball with dissipation (inelastic)

Elastic collision - 2 particles (code)

Return to tutorial T5: Elastic collision (2 particles)

//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.

// Tutorial 5

/*
** This file is annotated with DoxyFile comments in order to show the code on
** the documentation - This is not needed for your real drivers.
** Please ignore these comments.
*/

#include <Species/LinearViscoelasticSpecies.h>
#include <Mercury3D.h>
#include <Particles/BaseParticle.h>

class Tutorial5 : public Mercury3D
{
  public:

  void setupInitialConditions()
  { 
    BaseParticle p0;
    p0.setSpecies(speciesHandler.getObject(0));
 
    p0.setRadius(0.005); //particle-1 radius
    p0.setPosition(Vec3D(0.25*getXMax(),0.5*getYMax(),0.5*getZMax()));
    p0.setVelocity(Vec3D(0.25,0.0,0.0));
    particleHandler.copyAndAddObject(p0); // 1st particle created

    p0.setRadius(0.005); // particle-2 radius
    p0.setPosition(Vec3D(0.75*getXMax(),0.5*getYMax(),0.5*getZMax()));
    p0.setVelocity(Vec3D(-0.25,0.0,0.0));
    particleHandler.copyAndAddObject(p0); // 2nd particle created
  }

};

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

  // Problem setup
  Tutorial5 problem;

  problem.setName("Tutorial5");
  problem.setSystemDimensions(3);
  problem.setGravity(Vec3D(0.0,0.0,0.0));
  problem.setXMax(0.5);
  problem.setYMax(0.25);
  problem.setZMax(0.5);
  problem.setTimeMax(2.0);

  // The normal spring stiffness and normal dissipation is computed and set as 
  // For collision time tc=0.005 and restitution coefficeint rc=1.0, 
  auto species = problem.speciesHandler.copyAndAddObject(LinearViscoelasticSpecies());
  species->setDensity(2500.0); // sets the species type-0 density
  species->setStiffness(258.5);// sets the spring stiffness
  species->setDissipation(0.0);// sets the dissipation

  problem.setSaveCount(10);
  problem.dataFile.setFileType(FileType::ONE_FILE);
  problem.restartFile.setFileType(FileType::ONE_FILE);
  problem.fStatFile.setFileType(FileType::NO_FILE);
  problem.eneFile.setFileType(FileType::NO_FILE);

  problem.setXBallsAdditionalArguments("-solidf -v0 -s .85");   

  problem.setTimeStep(.005/50.0); // (collision time)/50.0
  problem.solve(argc, argv);
  
  return 0;
}

Return to tutorial T5: Elastic collision (2 particles)

Elastic collisions with periodic boundaries (code)

Return to tutorial T6: Elastic collisions with periodic boundaries

//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.

// Tutorial 6

/*
** This file is annotated with DoxyFile comments in order to show the code on
** the documentation - This is not needed for your real drivers.
** Please ignore these comments.
*/

#include <Species/LinearViscoelasticSpecies.h>
#include <Mercury3D.h>
#include <Particles/BaseParticle.h>
#include <Boundaries/PeriodicBoundary.h>

class Tutorial6 : public Mercury3D
{
  public:

  void setupInitialConditions()
  { 
    BaseParticle p0;
    p0.setSpecies(speciesHandler.getObject(0));
    p0.setRadius(0.5);//particle-1
    p0.setPosition(Vec3D(0.25*getXMax(),0.5*getYMax(),0.75*getZMax()));
    p0.setVelocity(Vec3D(0.5,0.0,-0.3));
    particleHandler.copyAndAddObject(p0);

    p0.setRadius(0.6);// particle-2
    p0.setPosition(Vec3D(0.75*getXMax(),0.5*getYMax(),0.5*getZMax()));
    p0.setVelocity(Vec3D(-0.5,0.0,0.3));
    particleHandler.copyAndAddObject(p0);

    PeriodicBoundary b0;
    b0.set(Vec3D(1.0,0.0,0.0),getXMin(),getXMax());
    boundaryHandler.copyAndAddObject(b0);
  }

};

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

  // Problem setup
  Tutorial6 problem; // instantiate an object of class Tutorial 6

  problem.setName("Tutorial6");
  problem.setSystemDimensions(3);
  problem.setGravity(Vec3D(0.0,0.0,0.0));
  problem.setXMax(5.0);
  problem.setYMax(2.5);
  problem.setZMax(5.0);
  problem.setTimeMax(10.0);

  // The normal spring stiffness and normal dissipation is computed and set as 
  // For collision time tc=0.005 and restitution coefficeint rc=1.0, 
  auto species = problem.speciesHandler.copyAndAddObject(LinearViscoelasticSpecies());
  species->setDensity(2500.0); // sets the species type-0 density
  species->setStiffness(200000);// sets the spring stiffness
  species->setDissipation(0.2);// sets the dissipation

  problem.setSaveCount(100);
  problem.dataFile.setFileType(FileType::ONE_FILE);
  problem.restartFile.setFileType(FileType::ONE_FILE);
  problem.fStatFile.setFileType(FileType::NO_FILE);
  problem.eneFile.setFileType(FileType::NO_FILE);
  
  problem.setXBallsAdditionalArguments("-solidf -v0");  

  problem.setTimeStep(0.005/50.0);// (collision time)/50.0
  problem.solve(argc, argv);
  
  return 0;
}

Return to tutorial T6: Elastic collisions with periodic boundaries

Motion of a particle in a two dimensional box (code)

Return to tutorial T7: Motion of a particle in a two dimensional (2D) box

//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.

// Tutorial 7

/*
** This file is annotated with DoxyFile comments in order to show the code on
** the documentation - This is not needed for your real drivers.
** Please ignore these comments.
*/

#include <Species/LinearViscoelasticSpecies.h>
#include <Mercury3D.h>
#include <Particles/BaseParticle.h>
#include <Walls/InfiniteWall.h> 

class Tutorial7 : public Mercury3D
{
  public:

  void setupInitialConditions()
  { 
    BaseParticle p0;
    p0.setSpecies(speciesHandler.getObject(0));
    p0.setRadius(0.005);
    p0.setPosition(Vec3D(0.5*getXMax(),0.5*getYMax(),0.0));
    p0.setVelocity(Vec3D(1.2,1.3,0.0));
    particleHandler.copyAndAddObject(p0);

    InfiniteWall w0;
    
    w0.setSpecies(speciesHandler.getObject(0));
    w0.set(Vec3D(1.0,0.0,0.0),Vec3D(getXMax(),0.0,0.0));
    wallHandler.copyAndAddObject(w0);

    w0.set(Vec3D(-1.0,0.0,0.0),Vec3D(getXMin(),0.0,0.0));
    wallHandler.copyAndAddObject(w0);

    w0.set(Vec3D(0.0,1.0,0.0),Vec3D(0.0,getYMax(),0.0));
    wallHandler.copyAndAddObject(w0);

    w0.set(Vec3D(0.0,-1.0,0.0),Vec3D(0.0,getYMin(),0.0));
    wallHandler.copyAndAddObject(w0);
  }

};

int main(int argc, char *argv[])
{
  // Problem setup
  Tutorial7 problem; // instantiate an object of class Tutorial 6

  problem.setName("Tutorial7");
  problem.setSystemDimensions(2);
  problem.setGravity(Vec3D(0.0,0.0,0.0));
  problem.setXMax(1);
  problem.setYMax(0.5);
  problem.setZMax(1.0);
  problem.setTimeMax(1.0);

  // The normal spring stiffness and normal dissipation is computed and set as 
  // For collision time tc=0.005 and restitution coefficeint rc=1.0, 
  auto species = problem.speciesHandler.copyAndAddObject(LinearViscoelasticSpecies());
  species->setDensity(2500.0); // sets the species type-0 density
  species->setStiffness(258.5);// sets the spring stiffness
  species->setDissipation(0.0);// sets the dissipation

  problem.setSaveCount(10);
  problem.dataFile.setFileType(FileType::ONE_FILE);
  problem.restartFile.setFileType(FileType::ONE_FILE);
  problem.fStatFile.setFileType(FileType::NO_FILE);
  problem.eneFile.setFileType(FileType::NO_FILE);
  
  problem.setWallsWriteVTK(FileType::ONE_FILE);
  problem.setParticlesWriteVTK(true);
  
  problem.setXBallsAdditionalArguments("-solidf -v0 -s .85");   

  problem.setTimeStep(0.005/50.0);// (collision time)/50.0
  problem.solve(argc, argv);

  return 0;
}

Return to tutorial T7: Motion of a particle in a two dimensional (2D) box

Motion of a particle in a box with an obstacle (code)

Return to tutorial T8: Motion of a particle in a box with an obstacle

//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.

// Tutorial 8

/*
** This file is annotated with DoxyFile comments in order to show the code on
** the documentation - This is not needed for your real drivers.
** Please ignore these comments.
*/

#include <Species/LinearViscoelasticSpecies.h>
#include <Mercury3D.h>
#include <Particles/BaseParticle.h>
#include <Walls/InfiniteWall.h>
#include <Walls/IntersectionOfWalls.h>

class Tutorial8 : public Mercury3D
{
  public:

  void setupInitialConditions()
  { 
    BaseParticle p0;
    p0.setSpecies(speciesHandler.getObject(0));
    p0.setRadius(0.005);
    p0.setPosition(Vec3D(0.15*getXMax(),0.3335*getYMax(),0.0));
    p0.setVelocity(Vec3D(1.2,0.2,0.0));
    particleHandler.copyAndAddObject(p0);

    InfiniteWall w0;

    w0.setSpecies(speciesHandler.getObject(0));
    w0.set(Vec3D(1.0,0.0,0.0),Vec3D(getXMax(), 0.0, 0.0));
    wallHandler.copyAndAddObject(w0);

    w0.set(Vec3D(-1.0,0.0,0.0),Vec3D(getXMin(), 0.0, 0.0));
    wallHandler.copyAndAddObject(w0);
 
    w0.set(Vec3D(0.0,1.0,0.0),Vec3D(0.0, getYMax(), 0.0));
    wallHandler.copyAndAddObject(w0);

    w0.set(Vec3D(0.0,-1.0,0.0),Vec3D(0.0, getYMin(), 0.0));
    wallHandler.copyAndAddObject(w0);

    IntersectionOfWalls w1;
    w1.addObject(Vec3D(-1.0,0.0,0.0),Vec3D(0.75*getXMax(),0.0,0.0));
    w1.addObject(Vec3D(1.0,0.0,0.0),Vec3D(0.25*getXMax(),0.0,0.0));
    w1.addObject(Vec3D(0.0,-1.0,0.0),Vec3D(0.0,0.75*getYMax(),0.0));
    w1.addObject(Vec3D(0.0,1.0,0.0),Vec3D(0.0,0.25*getYMax(),0.0));
    wallHandler.copyAndAddObject(w1);
  }

};

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

  // Problem setup
  Tutorial8 problem; // instantiate an object of class Tutorial 8
 
  problem.setName("Tutorial8");
  problem.setSystemDimensions(2);
  problem.setGravity(Vec3D(0.0,0.0,0.0));
  problem.setXMax(0.5);
  problem.setYMax(0.5);
  problem.setTimeMax(5.0);

  // The normal spring stiffness and normal dissipation is computed and set as 
  // For collision time tc=0.005 and restitution coefficeint rc=1.0, 
  auto species = problem.speciesHandler.copyAndAddObject(LinearViscoelasticSpecies());
  species->setDensity(2500.0); // sets the species type-0 density
  species->setStiffness(258.5);// sets the spring stiffness
  species->setDissipation(0.0);// sets the dissipation

  problem.setSaveCount(10);
  problem.dataFile.setFileType(FileType::ONE_FILE);
  problem.restartFile.setFileType(FileType::ONE_FILE);
  problem.fStatFile.setFileType(FileType::NO_FILE);
  problem.eneFile.setFileType(FileType::NO_FILE);

  problem.setXBallsAdditionalArguments("-solidf -v0 -s .85");   

  problem.setTimeStep(.005/50.0); // (collision time)/50.0
  problem.solve(argc, argv);

  return 0;
}

Return to tutorial T8: Motion of a particle in a box with an obstacle

Motion of a ball over an inclined plane (code)

Return to tutorial T9: Motion of a ball over an inclined plane (Sliding + Rolling)

//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.

// Tutorial 9

/*
** This file is annotated with DoxyFile comments in order to show the code on
** the documentation - This is not needed for your real drivers.
** Please ignore these comments.
*/

#include <Species/LinearViscoelasticFrictionSpecies.h>
#include <Mercury3D.h>
#include <Particles/BaseParticle.h>
#include <Walls/InfiniteWall.h>

class Tutorial9 : public Mercury3D
{
  public:

  void setupInitialConditions()
  { 
    BaseParticle p0;

    p0.setSpecies(speciesHandler.getObject(0));
    p0.setRadius(0.005);
    p0.setPosition(Vec3D(0.05*getXMax(),0.01*getYMax(),getZMin()+p0.getRadius()));
    p0.setVelocity(Vec3D(0.0,0.0,0.0));
    particleHandler.copyAndAddObject(p0);

    // sets the particle to species type-2
    p0.setSpecies(speciesHandler.getObject(1));
    p0.setRadius(0.005);
    p0.setPosition(Vec3D(0.05*getXMax(),0.21*getYMax(),getZMin()+p0.getRadius()));
    p0.setVelocity(Vec3D(0.0,0.0,0.0));
    particleHandler.copyAndAddObject(p0);

    // sets the particle to species type-3
    p0.setSpecies(speciesHandler.getObject(2));
    p0.setRadius(0.005);
    p0.setPosition(Vec3D(0.05*getXMax(),0.41*getYMax(),getZMin()+p0.getRadius()));
    p0.setVelocity(Vec3D(0.0,0.0,0.0));
    particleHandler.copyAndAddObject(p0);


    InfiniteWall w0;

    w0.setSpecies(speciesHandler.getObject(0));
    w0.set(Vec3D(0.0,0.0,-1.0),Vec3D(0.0,0.0,getZMin()));
    wallHandler.copyAndAddObject(w0);

  }

};

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

  // Problem setup
  Tutorial9 problem; // instantiate an object of class Tutorial 9

  double angle = constants::pi/180.0*20.0;
  
  problem.setName("Tutorial9");
  problem.setSystemDimensions(3);
  problem.setGravity(Vec3D(sin(angle),0.0,-cos(angle))*9.81);
  problem.setXMax(0.3);
  problem.setYMax(0.3);
  problem.setZMax(0.05);
  problem.setTimeMax(0.5);

  auto species0 = problem.speciesHandler.copyAndAddObject(LinearViscoelasticFrictionSpecies());
  auto species1 = problem.speciesHandler.copyAndAddObject(LinearViscoelasticFrictionSpecies());
  auto species2 = problem.speciesHandler.copyAndAddObject(LinearViscoelasticFrictionSpecies());
  auto species01 = problem.speciesHandler.getMixedObject(species0, species1);
  auto species02 = problem.speciesHandler.getMixedObject(species0, species2);

  // The normal spring stiffness and normal dissipation is computed and set as 
  // For collision time tc=0.005 and restitution coefficeint rc=0.88, 

  species0->setDensity(2500.0); // sets the species type-0 density
  species0->setStiffness(259.018);// sets the spring stiffness
  species0->setSlidingStiffness(2.0/7.0*species0->getStiffness());
  species0->setRollingStiffness(2.0/5.0*species0->getStiffness());
  species0->setDissipation(0.0334);// sets the dissipation
  species0->setSlidingFrictionCoefficient(0.0);
  species0->setRollingFrictionCoefficient(0.0);
  
  species1->setDensity(2500.0); // sets the species type-1 density
  species1->setStiffness(259.018);// sets the spring stiffness
  species1->setDissipation(0.0334);// sets the dissipation
  species1->setSlidingStiffness(2.0/7.0*species1->getStiffness());
  species1->setRollingStiffness(2.0/5.0*species1->getStiffness());
  species1->setSlidingFrictionCoefficient(0.5);
  species1->setRollingFrictionCoefficient(0.0);

  species01->setStiffness(259.018); 
  species01->setDissipation(0.0334);// sets the dissipation
  species01->setSlidingStiffness(2.0/7.0*species01->getStiffness());
  species01->setRollingStiffness(2.0/5.0*species01->getStiffness());
  species01->setSlidingFrictionCoefficient(0.5);
  species01->setRollingFrictionCoefficient(0.0);

  species2->setDensity(2500.0); // sets the species type-2 density
  species2->setStiffness(258.5);// sets the spring stiffness
  species2->setDissipation(0.0);// sets the dissipation
  species2->setSlidingStiffness(2.0/7.0*species2->getStiffness());
  species2->setRollingStiffness(2.0/5.0*species2->getStiffness());
  species2->setSlidingFrictionCoefficient(0.5);
  species2->setRollingFrictionCoefficient(0.5);

  species02->setStiffness(259.018); 
  species02->setDissipation(0.0334);// sets the dissipation
  species02->setSlidingStiffness(2.0/7.0*species02->getStiffness());
  species02->setRollingStiffness(2.0/5.0*species02->getStiffness());
  species02->setSlidingFrictionCoefficient(0.5);
  species02->setRollingFrictionCoefficient(0.5);

  problem.setSaveCount(10);
  problem.dataFile.setFileType(FileType::ONE_FILE);
  problem.restartFile.setFileType(FileType::ONE_FILE);
  problem.fStatFile.setFileType(FileType::ONE_FILE);
  problem.eneFile.setFileType(FileType::NO_FILE);

  problem.setXBallsAdditionalArguments("-solidf -v0 -s 8 -p 10 -rottheta .2 -noborder 4 -cube -o 100 -w 600 -h 300");   

  problem.setTimeStep(0.005/50.0);
  problem.solve(argc, argv);

  return 0;
}

Return to tutorial T9: Motion of a ball over an inclined plane (Sliding + Rolling)

Particles driven by a rotating coil (code)

Return to tutorial Particles driven by a rotating coil

#include "Mercury3D.h"
#include "Particles/BaseParticle.h"
#include "Walls/InfiniteWall.h"
#include "Walls/InfiniteWallWithHole.h"
#include "Walls/Coil.h"
#include "Species/LinearViscoelasticSpecies.h"


class CoilSelfTest : public Mercury3D
{

private:

    void setupInitialConditions() override
    {
        // gravity, particle radius
        setGravity(Vec3D(0.0, -9.8, 0.0));
        const double particleRadius = 0.2;
        
        // set problem geometry
        setXMax(1.0);
        setYMax(5.0);
        setZMax(2.0);
        setXMin(-1.0);
        setYMin(-1.0);
        
        LinearViscoelasticSpecies species;
        species.setDensity(1000);
        const double tc = 0.05;
        const double restitutionCoefficient = 0.8;
        const double particleMass = pow(particleRadius, 3) * constants::pi * 4.0 / 3.0 * species.getDensity();
        species.setCollisionTimeAndRestitutionCoefficient(tc, restitutionCoefficient, particleMass);
        speciesHandler.copyAndAddObject(species);
        
        InfiniteWall w;
        w.setSpecies(speciesHandler.getObject(0));
        //front wall
        w.set(Vec3D(-1, 0, 0), Vec3D(getXMin(), 0, 0));
        wallHandler.copyAndAddObject(w);

        //back wall
        w.set(Vec3D(1, 0, 0), Vec3D(getXMax(), 0, 0));
        wallHandler.copyAndAddObject(w);

        //bottom wall
        w.set(Vec3D(0, -1, 0), Vec3D(0, getYMin(), 0));
        wallHandler.copyAndAddObject(w);

        //top wall
        w.set(Vec3D(0, 1, 0), Vec3D(0, getYMax(), 0));
        wallHandler.copyAndAddObject(w);

        //left wall
        w.set(Vec3D(0, 0, -1), Vec3D(0, 0, getZMin()));
        wallHandler.copyAndAddObject(w);

        //right wall
        InfiniteWallWithHole rightWall;
        rightWall.setSpecies(speciesHandler.getObject(0));
        rightWall.set(Vec3D(0, 0, 1), getZMax(), 1.0);
        wallHandler.copyAndAddObject(rightWall);
        
        // creation of the coil and setting of its properties
        coil = wallHandler.copyAndAddObject(Coil());
        coil->setSpecies(speciesHandler.getObject(0));
        // the syntax to set the coil geometry is as follows:
        // set(Start position, Length, Radius, Number of turns, Rotation speed, Thickness)
        coil->set(Vec3D(0, 0, 0), 1.0, 1.0 - particleRadius, 2.0, -1.0, 0.5 * particleRadius);
        
        particleHandler.clear();
        BaseParticle p0;
        p0.setSpecies(speciesHandler.getObject(0));
        p0.setVelocity(Vec3D(0.0, 0.0, 0.0));
        p0.setRadius(particleRadius);

        /*
        //Single test case
        double distance;
                Vec3D normal;
        p0.setPosition(Vec3D(1.0,0.0,0.0));
        if(coil->getDistance_and_normal(p0, distance, normal))
                        std::cout<<"Collision, distance screw="<<distance<<std::endl;
                else
                        std::cout<<"No collision, distance screw="<<distance<<std::endl;
         */
        
        // Nx*Ny*Nz particles are created and placed on evenly spaced positions in 
        // the domain [xMin_,xMax_]*[yMin_,yMax_]*[zMin_,zMax_] (unless their position 
        // is already occupied by the coil).
        const unsigned int Nx = static_cast<unsigned int> (std::floor((getXMax() - getXMin()) / (2.1 * particleRadius)));
        const unsigned int Ny = static_cast<unsigned int> (std::floor((getYMax() - getYMin()) / (2.1 * particleRadius)));
        const unsigned int Nz = static_cast<unsigned int> (std::floor((getZMax() - getZMin()) / (2.1 * particleRadius)));
        Mdouble distance;
        Vec3D normal;
        
        // Place particles
        for (unsigned int i = 0; i < Nx; i++)
        {
            for (unsigned int j = 0; j < Ny; j++)
            {
                for (unsigned int k = 0; k < Nz; k++)
                {
                    p0.setPosition(Vec3D(getXMin() + (getXMax() - getXMin()) * (0.5 + i) / Nx,
                                         getYMin() + (getYMax() - getYMin()) * (0.5 + j) / Ny,
                                         getZMin() + (getZMax() - getZMin()) * (0.5 + k) / Nz));
                    if (!coil->getDistanceAndNormal(p0, distance, normal)) //if there is no collision with the coil
                    {
                        particleHandler.copyAndAddObject(p0);
                    }
                    else
                    {
                        logger(DEBUG, "particle at position % could not be inserted", p0.getPosition());
                    }
                }
            }
        }
    }
    
    void actionsBeforeTimeStep() override
    {
        if (getTime() > 1)
        {
            coil->move_time(getTimeStep());
        }

    }
public:
    // ! [CST:datamembers]
    Coil* coil;
};

int main(int argc UNUSED, char* argv[] UNUSED)
{
    
    // create CoilSelfTest object
    CoilSelfTest problem;
    
    // set some basic problem properties
    problem.setName("CoilSelfTest");
    problem.setSystemDimensions(3);
    problem.setTimeStep(0.02 * 0.05);
    problem.setTimeMax(0.5);
    problem.setSaveCount(helpers::getSaveCountFromNumberOfSavesAndTimeMaxAndTimestep(1000, problem.getTimeMax(),
                                                                                     problem.getTimeStep()));

    // actually solving the problem
    problem.solve();
    
}
// the end

Return to tutorial Particles driven by a rotating coil

Particles on an inclined chute (code)

Return to tutorial Particles on an inclined chute

#include <iostream>
#include <Species/LinearViscoelasticSpecies.h>
#include "Chute.h"

// Creates a quasi-2D inclined plane with inflow conditions on the left boundary, 
// and deletion of particles when they exit the domain on the right.
int main() 
{
    
    // Problem parameters
    Chute problem;
    
    problem.setName("ChuteDemo");   // data output file name
    problem.setSaveCount(102);      // number of time steps skipped between saves
    Mdouble tc = 2.5e-3;            // collision time
    problem.setTimeStep(0.02 * tc); // actual time step
    problem.setTimeMax(0.5);        // maximum time
                                    // NB: number of time steps saved to output files
                                    // is timeMax/(timeStep*saveCount)
    
    // Particle radii
    problem.setFixedParticleRadius(0.001);  // radius of fixed chute bottom particles
    problem.setInflowParticleRadius(0.001); // radius of (monodisperse) inflow particles

    // Particle species
    LinearViscoelasticSpecies species;              // initialise species
    species.setHandler(&problem.speciesHandler);    // assign problem species handler to species
    species.setDensity(2000);                       // particle density
    species.setCollisionTimeAndRestitutionCoefficient( tc, 
            0.8, species.getMassFromRadius(problem.getInflowParticleRadius())); // material properties
    problem.speciesHandler.copyAndAddObject(species);   // assign species to problem species handler
    

    // Chute properties
    problem.setChuteAngle(30.0);                    // set angle of chute relative to horizontal
    problem.setXMax(0.1);                           // chute length = 0.1
    problem.setYMax(2.0 * problem.getInflowParticleRadius()); // chute width = 1 particle diameter

    // Inflow properties
    problem.setInflowHeight(0.1);                   // particle inflow between 0 <= Z <= 0.1
    problem.setInflowVelocity(0.1);                 // particle inflow mean velocity
    problem.setInflowVelocityVariance(0.02);        // particle inflow velocity variance (in ratio of the mean velocity)

    //solve
    problem.solve();
} // the end

Return to tutorial Particles on an inclined chute

Particles on a chute with a multilayered bottom (code)

Return to tutorial Particles on a chute with a multilayered bottom

Return to tutorial Particles on a chute with a multilayered bottom