diff --git a/README b/README deleted file mode 100755 index 2a7f869..0000000 --- a/README +++ /dev/null @@ -1,81 +0,0 @@ -/*---------------------------------------------------------------------------*\ - CFDEMcoupling - Open Source CFD-DEM coupling - - CFDEMcoupling is part of the CFDEMproject - www.cfdem.com - Christoph Goniva, christoph.goniva@cfdem.com - Copyright 2009-2012 JKU Linz - Copyright 2012- DCS Computing GmbH, Linz -------------------------------------------------------------------------------- -License - This file is part of CFDEMcoupling. - - CFDEMcoupling is free software; you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by the - Free Software Foundation; either version 3 of the License, or (at your - option) any later version. - - CFDEMcoupling 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 General Public License - for more details. - - You should have received a copy of the GNU General Public License - along with CFDEMcoupling; if not, write to the Free Software Foundation, - Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - -Description - This code provides models and solvers to realize coupled CFD-DEM simulations - using LIGGGHTS and OpenFOAM. - Note: this code is not part of OpenFOAM (see DISCLAIMER). -\*---------------------------------------------------------------------------*/ - - -CFDEM(R) coupling provides an open source parallel coupled CFD-DEM framework -combining the strengths of LIGGGHTS(R) DEM code and the Open Source -CFD package OpenFOAM(R)(*). The CFDEM(R)coupling toolbox allows to expand -standard CFD solvers of OpenFOAM(R)(*) to include a coupling to the DEM -code LIGGGHTS(R). In this toolbox the particle representation within the -CFD solver is organized by "cloud" classes. Key functionalities are organised -in sub-models (e.g. force models, data exchange models, etc.) which can easily -be selected and combined by dictionary settings. - -The coupled solvers run fully parallel on distributed-memory clusters. - -Features are: - -- its modular approach allows users to easily implement new models -- its MPI parallelization enables to use it for large scale problems -- the "forum"_lws on CFD-DEM gives the possibility to exchange with other - users / developers -- the use of GIT allows to easily update to the latest version -- basic documentation is provided - -The file structure: - -- "src" directory including the source files of the coupling toolbox and models -- "applications" directory including the solver files for coupled CFD-DEM simulations -- "doc" directory including the documentation of CFDEM(R)coupling -- "tutorials" directory including basic tutorial cases showing the functionality - - - -Details on installation are given on the "www.cfdem.com" - -The functionality of this CFD-DEM framwork is described via "tutorial cases" showing -how to use different solvers and models. - -CFDEM(R)coupling stands for Computational Fluid Dynamics (CFD) - -Discrete Element Method (DEM) coupling. - -CFDEM(R)coupling is an open-source code, distributed freely under the terms of the -GNU Public License (GPL). - -Core development of CFDEM(R)coupling is done by -Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012 - - -\*---------------------------------------------------------------------------*/ -(*) "OpenFOAM(R)"_of is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group. -This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks. -\*---------------------------------------------------------------------------*/ diff --git a/applications/.gitignore b/applications/.gitignore index 4459954..e4a0e5b 100644 --- a/applications/.gitignore +++ b/applications/.gitignore @@ -1,7 +1,117 @@ +# C++.gitignore from github +# Compiled Object files +*.slo +*.lo *.o -*.d +*.obj + +# Precompiled Headers +*.gch +*.pch + +# Compiled Dynamic libraries +*.so +*.dylib +*.dll + +# Fortran module files +*.mod + +# Compiled Static libraries +*.lai +*.la *.a -*.dep -log_* -log.* +*.lib + +# Executables +*.exe +*.out +*.app + +# .gitignore from OpenFOAM-2.1.x +# git-ls-files --others --exclude-from=.git/info/exclude +# Lines that start with '#' are comments. + +# editor and misc backup files - anywhere *~ +.*~ +*.bak +*.bak[0-9][0-9] +*.orig +*.orig[0-9][0-9] +\#*\# + +# file-browser settings - anywhere +.directory + +# CVS recovered versions - anywhere +.#* + +# objects and archives - anywhere +*.[oa] +*.la +*.so +*.jar + +# derived files +lex.yy.c + +# Corefiles +core + +# dependency files - anywhere +*.dep + +# lnInclude (symlink) folders - anywhere +lnInclude + +# build folders - anywhere +linux*Clang*/ +linux*Gcc*/ +linux*Icc*/ +linuxming*/ +SiCortex*Gcc*/ +solaris*Gcc*/ +SunOS*Gcc*/ +platforms/ + +# reinstate wmake/rules that might look like build folders +!wmake/rules/*/ + +# doxygen generated documentation +doc/Doxygen/html +doc/Doxygen/latex +doc/Doxygen/man +doc/Doxygen/DTAGS + +# generated files in the main directory (e.g. ReleaseNotes-?.?.html) +# and in the doc directory +*.html + +# untracked configuration files +/etc/prefs.csh +/etc/prefs.sh +/etc/config/prefs.csh +/etc/config/prefs.sh + +# source packages - anywhere +*.tar.bz2 +*.tar.gz +*.tar +*.tgz +*.gtgz + +# ignore the persistent .build tag in the main directory +/.build + +# ignore .timeStamp in the main directory +/.timeStamp + +# ignore .tags in the main directory +/.tags + +# ignore eclipse project files in the main directory +/.cproject +/.project + +# end-of-file diff --git a/applications/solvers/cfdemSolverIB/Make/options b/applications/solvers/cfdemSolverIB/Make/options index a51d1da..4175d7d 100755 --- a/applications/solvers/cfdemSolverIB/Make/options +++ b/applications/solvers/cfdemSolverIB/Make/options @@ -1,7 +1,7 @@ -include $(CFDEM_ADD_LIBS_DIR)/additionalLibs +include $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME) EXE_INC = \ - -I$(LIB_SRC)/turbulenceModels/incompressible/turbulenceModel \ + $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \ -I$(LIB_SRC)/transportModels \ -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \ -I$(LIB_SRC)/finiteVolume/lnInclude \ @@ -11,17 +11,14 @@ EXE_INC = \ -I$(LIB_SRC)/dynamicFvMesh/lnInclude \ -I$(LIB_SRC)/dynamicMesh/lnInclude \ -I$(LIB_SRC)/dynamicMesh/dynamicFvMesh/lnInclude \ - -I$(LIB_SRC)/dynamicMesh/dynamicMesh/lnInclude \ - -I$(LIB_SRC)/fvOptions/lnInclude + -I$(LIB_SRC)/dynamicMesh/dynamicMesh/lnInclude EXE_LIBS = \ -L$(CFDEM_LIB_DIR)\ - -lincompressibleRASModels \ - -lincompressibleLESModels \ + $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \ -lincompressibleTransportModels \ -lfiniteVolume \ -ldynamicFvMesh \ -ldynamicMesh \ - -lfvOptions \ -l$(CFDEM_LIB_NAME) \ $(CFDEM_ADD_LIB_PATHS) \ $(CFDEM_ADD_LIBS) diff --git a/applications/solvers/cfdemSolverIB/cfdemSolverIB.C b/applications/solvers/cfdemSolverIB/cfdemSolverIB.C index 9c930e6..7be29bc 100755 --- a/applications/solvers/cfdemSolverIB/cfdemSolverIB.C +++ b/applications/solvers/cfdemSolverIB/cfdemSolverIB.C @@ -39,7 +39,14 @@ Contributions #include "fvCFD.H" #include "singlePhaseTransportModel.H" -#include "turbulenceModel.H" +#include "OFversion.H" + +#if defined(version30) + #include "turbulentTransportModel.H" + #include "pisoControl.H" +#else + #include "turbulenceModel.H" +#endif #include "cfdemCloudIB.H" #include "implicitCouple.H" @@ -48,7 +55,7 @@ Contributions #include "regionModel.H" #include "voidFractionModel.H" -#include "dynamicFvMesh.H" //dyM +#include "dynamicFvMesh.H" #include "cellSet.H" @@ -67,12 +74,17 @@ int main(int argc, char *argv[]) #include "createDynamicFvMesh.H" + #if defined(version30) + pisoControl piso(mesh); + #include "createTimeControls.H" + #endif + #include "createFields.H" #include "initContinuityErrs.H" #if defined(version22) - #include "createFvOptions.H" + #include "createFvOptions.H" #endif // create cfdemCloud @@ -91,12 +103,18 @@ int main(int argc, char *argv[]) interFace = mag(mesh.lookupObject("voidfractionNext")); mesh.update(); //dyM - #include "readPISOControls.H" - #include "CourantNo.H" + #if defined(version30) + #include "readTimeControls.H" + #include "CourantNo.H" + #include "setDeltaT.H" + #else + #include "readPISOControls.H" + #include "CourantNo.H" + #endif // do particle stuff Info << "- evolve()" << endl; - particleCloud.evolve(); + particleCloud.evolve(voidfraction); // Pressure-velocity PISO corrector { @@ -104,7 +122,7 @@ int main(int argc, char *argv[]) fvVectorMatrix UEqn ( - fvm::ddt(voidfraction,U) + fvm::ddt(U) //fvm::ddt(voidfraction,U) + fvm::div(phi, U) + turbulence->divDevReff(U) #if defined(version22) @@ -119,13 +137,21 @@ int main(int argc, char *argv[]) fvOptions.constrain(UEqn); #endif - if (momentumPredictor) + #if defined(version30) + if (piso.momentumPredictor()) + #else + if (momentumPredictor) + #endif { solve(UEqn == -fvc::grad(p)); } // --- PISO loop - for (int corr=0; corr()); - Info << "TotalForceExp: " << fTotal << endl; - Info << "TotalForceImp: " << fImpTotal << endl; + //Force Checks + #include "forceCheckIm.H" #include "solverDebugInfo.H" particleCloud.clockM().stop("Coupling"); @@ -111,17 +131,26 @@ int main(int argc, char *argv[]) ); UEqn.relax(); - if (momentumPredictor && (modelType=="B" || modelType=="Bfull")) - solve(UEqn == - fvc::grad(p) + Ksl/rho*Us); - else if (momentumPredictor) - solve(UEqn == - voidfraction*fvc::grad(p) + Ksl/rho*Us); + + #if defined(version30) + if (piso.momentumPredictor()) + #else + if (momentumPredictor) + #endif + { + if (modelType=="B" || modelType=="Bfull") + solve(UEqn == - fvc::grad(p) + Ksl/rho*Us); + else + solve(UEqn == - voidfraction*fvc::grad(p) + Ksl/rho*Us); + } // --- PISO loop - - //for (int corr=0; corr + ( + p.boundaryField(), + ( + phi.boundaryField() + - (mesh.Sf().boundaryField() & U.boundaryField()) + )/(mesh.magSf().boundaryField()*rUAf.boundaryField()*voidfractionf.boundaryField()) + ); + }else + { + setSnGrad + ( + p.boundaryField(), + ( + phi.boundaryField() + - (mesh.Sf().boundaryField() & U.boundaryField()) + )/(mesh.magSf().boundaryField()*rUAf.boundaryField()) + ); + } + #endif + // Non-orthogonal pressure corrector loop - for (int nonOrth=0; nonOrth<=nNonOrthCorr; nonOrth++) + #if defined(version30) + while (piso.correctNonOrthogonal()) + #else + for (int nonOrth=0; nonOrth<=nNonOrthCorr; nonOrth++) + #endif { // Pressure corrector fvScalarMatrix pEqn @@ -154,24 +213,29 @@ int main(int argc, char *argv[]) ); pEqn.setReference(pRefCell, pRefValue); - if - ( - corr == nCorr-1 - && nonOrth == nNonOrthCorr - ) - { - pEqn.solve(mesh.solver("pFinal")); - } - else - { - pEqn.solve(); - } + #if defined(version30) + pEqn.solve(mesh.solver(p.select(piso.finalInnerIter()))); + if (piso.finalNonOrthogonalIter()) + { + phiGes -= pEqn.flux(); + phi = phiGes; + } + #else + if( corr == nCorr-1 && nonOrth == nNonOrthCorr ) + #if defined(versionExt32) + pEqn.solve(mesh.solutionDict().solver("pFinal")); + #else + pEqn.solve(mesh.solver("pFinal")); + #endif + else + pEqn.solve(); - if (nonOrth == nNonOrthCorr) - { - phiGes -= pEqn.flux(); - phi = phiGes; - } + if (nonOrth == nNonOrthCorr) + { + phiGes -= pEqn.flux(); + phi = phiGes; + } + #endif } // end non-orthogonal corrector loop diff --git a/applications/solvers/cfdemSolverPisoSTM/Make/files b/applications/solvers/cfdemSolverPisoSTM/Make/files new file mode 100644 index 0000000..e74a983 --- /dev/null +++ b/applications/solvers/cfdemSolverPisoSTM/Make/files @@ -0,0 +1,3 @@ +cfdemSolverPisoSTM.C + +EXE = $(CFDEM_APP_DIR)/cfdemSolverPisoSTM diff --git a/applications/solvers/cfdemSolverPisoSTM/Make/options b/applications/solvers/cfdemSolverPisoSTM/Make/options new file mode 100644 index 0000000..0658fe0 --- /dev/null +++ b/applications/solvers/cfdemSolverPisoSTM/Make/options @@ -0,0 +1,22 @@ +include $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME) + +EXE_INC = \ + $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \ + -I$(LIB_SRC)/transportModels \ + -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \ + -I$(LIB_SRC)/finiteVolume/lnInclude \ + -I$(LIB_SRC)/meshTools/lnInclude \ + -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \ + -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/cfdTools \ + -I$(CFDEM_SRC_DIR)/eulerian/scalarTransportModelsCFDEM/lnInclude \ + +EXE_LIBS = \ + -L$(CFDEM_LIB_DIR)\ + $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \ + -lincompressibleTransportModels \ + -lfiniteVolume \ + -lmeshTools \ + -l$(CFDEM_LIB_NAME) \ + -lscalarTransportModelsCFDEM \ + $(CFDEM_ADD_LIB_PATHS) \ + $(CFDEM_ADD_LIBS) diff --git a/applications/solvers/cfdemSolverPisoSTM/cfdemSolverPisoSTM.C b/applications/solvers/cfdemSolverPisoSTM/cfdemSolverPisoSTM.C new file mode 100644 index 0000000..3bcea87 --- /dev/null +++ b/applications/solvers/cfdemSolverPisoSTM/cfdemSolverPisoSTM.C @@ -0,0 +1,221 @@ +/*---------------------------------------------------------------------------*\ + CFDEMcoupling - Open Source CFD-DEM coupling + + CFDEMcoupling is part of the CFDEMproject + www.cfdem.com + Christoph Goniva, christoph.goniva@cfdem.com + Copyright (C) 1991-2009 OpenCFD Ltd. + Copyright (C) 2012- DCS Computing GmbH,Linz +------------------------------------------------------------------------------- +License + This file is part of CFDEMcoupling. + + CFDEMcoupling is free software: you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + CFDEMcoupling 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 General Public License + for more details. + + You should have received a copy of the GNU General Public License + along with CFDEMcoupling. If not, see . + +Application + cfdemSolverPisoScalar + +Description + Transient solver for incompressible flow. + Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected. + The code is an evolution of the solver pisoFoam in OpenFOAM(R) 1.6, + where additional functionality for CFD-DEM coupling is added. +\*---------------------------------------------------------------------------*/ + +#include "fvCFD.H" +#include "singlePhaseTransportModel.H" +#include "turbulenceModel.H" + +#include "cfdemCloud.H" +#include "implicitCouple.H" +#include "smoothingModel.H" +#include "forceModel.H" + +#include "scalarTransportModel.H" +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +int main(int argc, char *argv[]) +{ + #include "setRootCase.H" + #include "createTime.H" + #include "createMesh.H" + #include "createFields.H" + #include "initContinuityErrs.H" + + // create cfdemCloud + #include "readGravitationalAcceleration.H" + cfdemCloud particleCloud(mesh); + #include "checkModelType.H" + + // create a scalarTransportModel + autoPtr stm + ( + scalarTransportModel::New(particleCloud.couplingProperties(),particleCloud) + ); + + // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + Info<< "\nStarting time loop\n" << endl; + while (runTime.loop()) + { + Info<< "Time = " << runTime.timeName() << nl << endl; + + #include "readPISOControls.H" + #include "CourantNo.H" + + // do particle stuff + bool hasEvolved = particleCloud.evolve(voidfraction,Us,U); + + if(hasEvolved) + { + particleCloud.smoothingM().smoothen(particleCloud.forceM(0).impParticleForces()); + } + + Info << "update Ksl.internalField()" << endl; + Ksl = particleCloud.momCoupleM(0).impMomSource(); + Ksl.correctBoundaryConditions(); + + + #include "solverDebugInfo.H" + + /*// get scalar source from DEM + particleCloud.forceM(1).manipulateScalarField(Tsource); + Tsource.correctBoundaryConditions();*/ + + stm().update(); + + /*// solve scalar transport equation + fvScalarMatrix TEqn + ( + fvm::ddt(voidfraction,T) - fvm::Sp(fvc::ddt(voidfraction),T) + + fvm::div(phi, T) - fvm::Sp(fvc::div(phi),T) + - fvm::laplacian(DT*voidfraction, T) + == + Tsource + ); + TEqn.relax(); + TEqn.solve();*/ + + if(particleCloud.solveFlow()) + { + // Pressure-velocity PISO corrector + { + // Momentum predictor + fvVectorMatrix UEqn + ( + fvm::ddt(voidfraction,U) - fvm::Sp(fvc::ddt(voidfraction),U) + + fvm::div(phi,U) - fvm::Sp(fvc::div(phi),U) +// + turbulence->divDevReff(U) + + particleCloud.divVoidfractionTau(U, voidfraction) + == + - fvm::Sp(Ksl/rho,U) + ); + + UEqn.relax(); + if (momentumPredictor && (modelType=="B" || modelType=="Bfull")) + solve(UEqn == - fvc::grad(p) + Ksl/rho*Us); + else if (momentumPredictor) + solve(UEqn == - voidfraction*fvc::grad(p) + Ksl/rho*Us); + + // --- PISO loop + + //for (int corr=0; corrcorrect(); + }// end solveFlow + else + { + Info << "skipping flow solution." << endl; + } + + runTime.write(); + + Info<< "ExecutionTime = " << runTime.elapsedCpuTime() << " s" + << " ClockTime = " << runTime.elapsedClockTime() << " s" + << nl << endl; + } + + Info<< "End\n" << endl; + + return 0; +} + + +// ************************************************************************* // diff --git a/applications/solvers/cfdemSolverPisoSTM/createFields.H b/applications/solvers/cfdemSolverPisoSTM/createFields.H new file mode 100644 index 0000000..b2b5654 --- /dev/null +++ b/applications/solvers/cfdemSolverPisoSTM/createFields.H @@ -0,0 +1,174 @@ + Info<< "Reading field p\n" << endl; + volScalarField p + ( + IOobject + ( + "p", + runTime.timeName(), + mesh, + IOobject::MUST_READ, + IOobject::AUTO_WRITE + ), + mesh + ); + + Info<< "Reading physical velocity field U" << endl; + Info<< "Note: only if voidfraction at boundary is 1, U is superficial velocity!!!\n" << endl; + volVectorField U + ( + IOobject + ( + "U", + runTime.timeName(), + mesh, + IOobject::MUST_READ, + IOobject::AUTO_WRITE + ), + mesh + ); + +//======================== +// drag law modelling +//======================== + + Info<< "\nReading momentum exchange field Ksl\n" << endl; + volScalarField Ksl + ( + IOobject + ( + "Ksl", + runTime.timeName(), + mesh, + IOobject::MUST_READ, + IOobject::AUTO_WRITE + ), + mesh + //dimensionedScalar("0", dimensionSet(0, 0, -1, 0, 0), 1.0) + ); + + Info<< "\nReading voidfraction field voidfraction = (Vgas/Vparticle)\n" << endl; + volScalarField voidfraction + ( + IOobject + ( + "voidfraction", + runTime.timeName(), + mesh, + IOobject::MUST_READ, + IOobject::AUTO_WRITE + ), + mesh + ); + + Info<< "\nCreating density field rho\n" << endl; + volScalarField rho + ( + IOobject + ( + "rho", + runTime.timeName(), + mesh, + IOobject::READ_IF_PRESENT, + IOobject::AUTO_WRITE + ), + mesh, + dimensionedScalar("0", dimensionSet(1, -3, 0, 0, 0), 1.0) + ); + + Info<< "Reading particle velocity field Us\n" << endl; + volVectorField Us + ( + IOobject + ( + "Us", + runTime.timeName(), + mesh, + IOobject::MUST_READ, + IOobject::AUTO_WRITE + ), + mesh + ); + +//======================== +// scalar field modelling +//======================== + /* Info<< "\nCreating dummy density field rho = 1\n" << endl; + volScalarField T + ( + IOobject + ( + "T", + runTime.timeName(), + mesh, + IOobject::MUST_READ, + IOobject::AUTO_WRITE + ), + mesh//, + //dimensionedScalar("0", dimensionSet(0, 0, -1, 1, 0), 273.15) + ); + + Info<< "\nCreating fluid-particle heat flux field\n" << endl; + volScalarField Tsource + ( + IOobject + ( + "Tsource", + runTime.timeName(), + mesh, + IOobject::MUST_READ, + IOobject::AUTO_WRITE + ), + mesh//, + //dimensionedScalar("0", dimensionSet(0, 0, -1, 1, 0), 0.0) + ); + + IOdictionary transportProperties + ( + IOobject + ( + "transportProperties", + runTime.constant(), + mesh, + IOobject::MUST_READ, + IOobject::NO_WRITE + ) + ); + + dimensionedScalar DT + ( + transportProperties.lookup("DT") + );*/ + +//======================== + +//# include "createPhi.H" +#ifndef createPhi_H +#define createPhi_H +Info<< "Reading/calculating face flux field phi\n" << endl; +surfaceScalarField phi + ( + IOobject + ( + "phi", + runTime.timeName(), + mesh, + IOobject::READ_IF_PRESENT, + IOobject::AUTO_WRITE + ), + linearInterpolate(U*voidfraction) & mesh.Sf() + ); +#endif + + + + label pRefCell = 0; + scalar pRefValue = 0.0; + setRefCell(p, mesh.solutionDict().subDict("PISO"), pRefCell, pRefValue); + + + singlePhaseTransportModel laminarTransport(U, phi); + + autoPtr turbulence + ( + incompressible::turbulenceModel::New(U, phi, laminarTransport) + ); diff --git a/applications/solvers/cfdemSolverPisoScalar/Make/options b/applications/solvers/cfdemSolverPisoScalar/Make/options index 68aecd1..6d83afe 100644 --- a/applications/solvers/cfdemSolverPisoScalar/Make/options +++ b/applications/solvers/cfdemSolverPisoScalar/Make/options @@ -1,19 +1,20 @@ -include $(CFDEM_ADD_LIBS_DIR)/additionalLibs +include $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME) EXE_INC = \ - -I$(LIB_SRC)/turbulenceModels/incompressible/turbulenceModel \ + $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \ -I$(LIB_SRC)/transportModels \ -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \ -I$(LIB_SRC)/finiteVolume/lnInclude \ + -I$(LIB_SRC)/meshTools/lnInclude \ -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \ -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/cfdTools \ EXE_LIBS = \ -L$(CFDEM_LIB_DIR)\ - -lincompressibleRASModels \ - -lincompressibleLESModels \ + $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \ -lincompressibleTransportModels \ -lfiniteVolume \ + -lmeshTools \ -l$(CFDEM_LIB_NAME) \ $(CFDEM_ADD_LIB_PATHS) \ $(CFDEM_ADD_LIBS) diff --git a/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C b/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C index 2a3e49a..f66e0d3 100644 --- a/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C +++ b/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C @@ -36,7 +36,14 @@ Description #include "fvCFD.H" #include "singlePhaseTransportModel.H" -#include "turbulenceModel.H" + +#include "OFversion.H" +#if defined(version30) + #include "turbulentTransportModel.H" + #include "pisoControl.H" +#else + #include "turbulenceModel.H" +#endif #include "cfdemCloud.H" #include "implicitCouple.H" @@ -50,6 +57,10 @@ int main(int argc, char *argv[]) #include "setRootCase.H" #include "createTime.H" #include "createMesh.H" + #if defined(version30) + pisoControl piso(mesh); + #include "createTimeControls.H" + #endif #include "createFields.H" #include "initContinuityErrs.H" @@ -64,8 +75,14 @@ int main(int argc, char *argv[]) { Info<< "Time = " << runTime.timeName() << nl << endl; - #include "readPISOControls.H" - #include "CourantNo.H" + #if defined(version30) + #include "readTimeControls.H" + #include "CourantNo.H" + #include "setDeltaT.H" + #else + #include "readPISOControls.H" + #include "CourantNo.H" + #endif // do particle stuff bool hasEvolved = particleCloud.evolve(voidfraction,Us,U); @@ -114,17 +131,27 @@ int main(int argc, char *argv[]) ); UEqn.relax(); - if (momentumPredictor && (modelType=="B" || modelType=="Bfull")) - solve(UEqn == - fvc::grad(p) + Ksl/rho*Us); - else if (momentumPredictor) - solve(UEqn == - voidfraction*fvc::grad(p) + Ksl/rho*Us); + #if defined(version30) + if (piso.momentumPredictor()) + #else + if (momentumPredictor) + #endif + { + if(modelType=="B" || modelType=="Bfull") + solve(UEqn == - fvc::grad(p) + Ksl/rho*Us); + else + solve(UEqn == - voidfraction*fvc::grad(p) + Ksl/rho*Us); + } // --- PISO loop //for (int corr=0; corrt

-

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks. OPENFOAM® is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group. +

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.

@@ -218,24 +218,27 @@ listing below of styles within certain commands. forceModel_KochHillDragforceModel_LaEuScalarTemp forceModel_MeiLiftforceModel_SchillerNaumannDrag forceModel_ShirgaonkarIBforceModel_fieldStore -forceModel_gradPForceforceModel_noDrag -forceModel_particleCellVolumeforceModel_virtualMassForce -forceModel_viscForceforceSubModel -forceSubModel_ImExforceSubModel_ImExCorr -liggghtsCommandModelliggghtsCommandModel_execute -liggghtsCommandModel_readLiggghtsDataliggghtsCommandModel_runLiggghts -liggghtsCommandModel_writeLiggghtslocateModel -locateModel_engineSearchlocateModel_engineSearchIB -locateModel_standardSearchmeshMotionModel -meshMotionModel_noMeshMotionmomCoupleModel -momCoupleModel_explicitCouplemomCoupleModel_implicitCouple -momCoupleModel_noCoupleprobeModel -probeModel_noProberegionModel +forceModel_fieldTimeAverageforceModel_gradPForce +forceModel_noDragforceModel_particleCellVolume +forceModel_particleVolumeforceModel_scalarGeneralExchange +forceModel_virtualMassForceforceModel_viscForce +forceModel_volWeightedAverageforceSubModel +forceSubModel_ImExliggghtsCommandModel +liggghtsCommandModel_executeliggghtsCommandModel_readLiggghtsData +liggghtsCommandModel_runLiggghtsliggghtsCommandModel_writeLiggghts +locateModellocateModel_engineSearch +locateModel_engineSearchIBlocateModel_standardSearch +meshMotionModelmeshMotionModel_noMeshMotion +momCoupleModelmomCoupleModel_explicitCouple +momCoupleModel_implicitCouplemomCoupleModel_noCouple +probeModelprobeModel_noProbe +probeModel_particleProberegionModel regionModel_allRegionsmoothingModel smoothingModel_constDiffSmoothingsmoothingModel_noSmoothing voidfractionModelvoidfractionModel_GaussVoidFraction voidfractionModel_IBVoidFractionvoidfractionModel_bigParticleVoidFraction -voidfractionModel_centreVoidFractionvoidfractionModel_dividedVoidFraction +voidfractionModel_centreVoidFractionvoidfractionModel_dividedVoidFraction +voidfractionModel_noVoidFractionVoidFractionvoidfractionModel_trilinearVoidFraction diff --git a/doc/CFDEMcoupling_Manual.pdf b/doc/CFDEMcoupling_Manual.pdf index dd30025..43b27ef 100644 Binary files a/doc/CFDEMcoupling_Manual.pdf and b/doc/CFDEMcoupling_Manual.pdf differ diff --git a/doc/CFDEMcoupling_Manual.txt b/doc/CFDEMcoupling_Manual.txt deleted file mode 100644 index 2f80b73..0000000 --- a/doc/CFDEMcoupling_Manual.txt +++ /dev/null @@ -1,304 +0,0 @@ -"CFDEMproject WWW Site"_lws :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) -:link(of,http://www.openfoam.com) -:link(lig,http://www.cfdem.com) - -:line -CFDEMcoupling Documentation :h2,c -:line -:c,image(Portfolio_CFDEMcoupling.png) -:line -1. Contents :h3 - -The CFDEMcoupling documentation is organized into the following sections. If you find any errors or omissions in this manual or have suggestions for useful information to add, please send an email to the developers so the CFDEMcoupling documentation can be improved. - -1.1 "About CFDEMcoupling"_#1_1 -1.2 "Installation"_#1_2 -1.3 "Tutorials"_#1_3 -1.4 "couplingProperties dictionary"_#1_4 -1.5 "liggghtsCommands dictionary"_#1_5 -1.6 "Models and solvers"_#cmd_5 :all(b) - -:line - -1.1 About CFDEMcoupling :link(1_1),h4 - -CFDEM coupling provides an open source parallel coupled CFD-DEM framework combining the strengths of "LIGGGHTS"_lig DEM code and the Open Source CFD package "OpenFOAM(R)(*)"_of. The CFDEMcoupling toolbox allows to expand standard CFD solvers of "OpenFOAM(R)(*)"_of to include a coupling to the DEM code "LIGGGHTS"_lig. In this toolbox the particle representation within the CFD solver is organized by "cloud" classes. Key functionalities are organised in sub-models (e.g. force models, data exchange models, etc.) which can easily be selected and combined by dictionary settings. - -The coupled solvers run fully parallel on distributed-memory clusters. Features are: - -its modular approach allows users to easily implement new models :ulb,l -its MPI parallelization enables to use it for large scale problems :l -the "forum"_lws on CFD-DEM gives the possibility to exchange with other users / developers :l -the use of GIT allows to easily update to the latest version :l -basic documentation is provided :l -:ule - -The file structure: - -{src} directory including the source files of the coupling toolbox and models :ulb,l -{applications} directory including the solver files for coupled CFD-DEM simulations :l -{doc} directory including the documentation of CFDEMcoupling :l -{tutorials} directory including basic tutorial cases showing the functionality :l -:ule - -Details on installation are given on the "CFDEMproject WWW Site"_lws . -The functionality of this CFD-DEM framework is described via "tutorial cases"_#_1_2 showing how to use different solvers and models. - -CFDEMcoupling stands for Computational Fluid Dynamics (CFD) -Discrete Element Method (DEM) coupling. - -CFDEMcoupling is an open-source code, distributed freely under the terms of the GNU Public License (GPL). - -Core development of CFDEMcoupling is done by Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012 - -This documentation was written by Christoph Goniva, DCS Computing GmbH, 2012 - -:line -(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks. OPENFOAM® is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group. - -:line - -1.2 Installation :link(1_2),h4 - -Please follow the installation routine provided at www.cfdem.com. -In order to get the latest code version, please use the git repository at http://github.com ("githubAccess"_githubAccess_public.html). - -:line - -1.3 Tutorials :link(1_3),h4 - -[General:] - -Each solver of the CFDEMcoupling comes with at least one tutorial example, showing its functionality and correct usage. Provided that the installation is correct, the tutorials can be run via "Allrun.sh" shell scripts. These scripts perform all necessary steps (preprocessing, run, postprocessing, visualization). - -[Location:] - -The tutorials can be found in the directory $CFDEM_PROJECT_DIR/tutorials, which can be reached by typing "cfdemTut" - -[Structure:] - -Each case is structured in a directory called "CFD" covering the CFD relevant settings and data, and a dirctory called "DEM" covering the DEM relevant settings and data. This allows to easily expand a pure CFD or DEM simulation case to a coupled case. - -[Usage:] - -Provided that the installation is correct, the tutorials can be run via "Allrun.sh" shell script, executed by typing "./Allrun.sh". The successful run of the script might need some third party software (e.g. octave, evince, etc.). - -[Settings:] - -The main settings of a simulation are done via dictionaries: - -The DEM setup of each case is defined by a "LIGGGHTS"_lig input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the "LIGGGHTS"_lig setup, please have a look at the "LIGGGHTS"_lig manual. - -Standard CFD settings are defined in $caseDir/CFD/constant (e.g. transportProperties, RASproperties, etc.) and $caseDir/CFD/system (e.g. fvSchemes, controlDict). You can find more information on that in "OpenFOAM(R)(*)"_of documentations (www.openFoam.com)(*). - -Settings of the coupling routines are defined in $caseDir/CFD/constant/"couplingProperies"_#1_3 (e.g. force models, data exchange model, etc.) and $caseDir/CFD/constant/"liggghtsCommands"_#1_3 (allows to execute a LIGGGHTS command during a coupled simulation). - -:line - -1.4 "couplingProperties" dictionary :link(1_4),h4 - -[General:] - -In the "couplingProperties" dictionary the setup of the coupling routines of the CFD-DEM simulation are defined. - -[Location:] $caseDir/CFD/constant - -[Structure:] - -The dictionary is divided into two parts, "sub-models & settings" and "sub-model properties". - -In "sub-models & settings" the following routines must be specified: - -modelType :ulb,l -couplingInterval :l -voidFractionModel :l -locateModel :l -meshMotionModel :l -regionModel :l -IOModel :l -dataExchangeModel :l -averagingModel :l -forceModels :l -momCoupleModels :l -turbulenceModelType :l -:ule - -In "sub-model properties" sub-dictionaries might be defined to specify model specific parameters. - -[Settings:] - -Reasonable example settings for the "couplingProperties" dictionary are given in the tutorial cases. - -modelType :pre - -"modelType" refers to the formulation of the equations to be solved. Choose "A", "B" or "Bfull", according to Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability", JFM. "A" requires the use of the force models gradPForce and viscForce, whereas "B" requires the force model "Archimedes". "Bfull" refers to model type I. - -couplingInterval :pre - -The coupling interval determines the time passing between two CFD-DEM data exchanges. - -A useful procedure would be: -1) Set the DEM timestep in the in.xxx file according to the needs of the pure DEM problem. -2) Set the "couplingInterval", which refers to the DEM timesteps. Depending on the problem you will need to have a close (small couplingInterval) or loose coupling. -3) Choose the CFD timestep in the controlDict. It must be equal to or smaller than the coupling time, otherwise you will get the error: "Error - TS bigger than coupling interval!". - -Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen every 0.0001s. - -:line - -1.5 "liggghtsCommands" dictionary :h4,link(1_5) - -[General:] - -In the "liggghtsCommands" dictionary liggghts commands being executed during a coupled CFD-DEM simulation are specified. - -[Location:] $caseDir/CFD/constant - -[Structure:] - -The dictionary is divided into two parts, first a list of "liggghtsCommandModels" is defined, then the settings for each model must be specified. - -[Settings:] - -Reasonable example settings for the "liggghtsCommands" dictionary are given in the tutorial cases. - -:line - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -1.6 Models/Solvers :h4,link(cmd_5),link(comm) - -This section lists all CFDEMcoupling sub-models and solvers alphabetically, with a separate -listing below of styles within certain commands. - - -"IOModel"_IOModel.html, -"IOModel_basicIO"_IOModel_basicIO.html, -"IOModel_noIO"_IOModel_noIO.html, -"IOModel_sophIO"_IOModel_sophIO.html, -"IOModel_trackIO"_IOModel_trackIO.html, -"averagingModel"_averagingModel.html, -"averagingModel_dense"_averagingModel_dense.html, -"averagingModel_dilute"_averagingModel_dilute.html, -"cfdemSolverIB"_cfdemSolverIB.html, -"cfdemSolverPiso"_cfdemSolverPiso.html, -"cfdemSolverPisoScalar"_cfdemSolverPisoScalar.html, -"clockModel"_clockModel.html, -"clockModel_noClock"_clockModel_noClock.html, -"clockModel_standardClock"_clockModel_standardClock.html, -"dataExchangeModel"_dataExchangeModel.html, -"dataExchangeModel_noDataExchange"_dataExchangeModel_noDataExchange.html, -"dataExchangeModel_oneWayVTK"_dataExchangeModel_oneWayVTK.html, -"dataExchangeModel_twoWayFiles"_dataExchangeModel_twoWayFiles.html, -"dataExchangeModel_twoWayMPI"_dataExchangeModel_twoWayMPI.html, -"forceModel"_forceModel.html, -"forceModel_Archimedes"_forceModel_Archimedes.html, -"forceModel_ArchimedesIB"_forceModel_ArchimedesIB.html, -"forceModel_DiFeliceDrag"_forceModel_DiFeliceDrag.html, -"forceModel_GidaspowDrag"_forceModel_GidaspowDrag.html, -"forceModel_KochHillDrag"_forceModel_KochHillDrag.html, -"forceModel_LaEuScalarTemp"_forceModel_LaEuScalarTemp.html, -"forceModel_MeiLift"_forceModel_MeiLift.html, -"forceModel_SchillerNaumannDrag"_forceModel_SchillerNaumannDrag.html, -"forceModel_ShirgaonkarIB"_forceModel_ShirgaonkarIB.html, -"forceModel_fieldStore"_forceModel_fieldStore.html, -"forceModel_gradPForce"_forceModel_gradPForce.html, -"forceModel_noDrag"_forceModel_noDrag.html, -"forceModel_particleCellVolume"_forceModel_particleCellVolume.html, -"forceModel_virtualMassForce"_forceModel_virtualMassForce.html, -"forceModel_viscForce"_forceModel_viscForce.html, -"forceSubModel"_forceSubModel.html, -"forceSubModel_ImEx"_forceSubModel_ImEx.html, -"forceSubModel_ImExCorr"_forceSubModel_ImExCorr.html, -"liggghtsCommandModel"_liggghtsCommandModel.html, -"liggghtsCommandModel_execute"_liggghtsCommandModel_execute.html, -"liggghtsCommandModel_readLiggghtsData"_liggghtsCommandModel_readLiggghtsData.html, -"liggghtsCommandModel_runLiggghts"_liggghtsCommandModel_runLiggghts.html, -"liggghtsCommandModel_writeLiggghts"_liggghtsCommandModel_writeLiggghts.html, -"locateModel"_locateModel.html, -"locateModel_engineSearch"_locateModel_engineSearch.html, -"locateModel_engineSearchIB"_locateModel_engineSearchIB.html, -"locateModel_standardSearch"_locateModel_standardSearch.html, -"meshMotionModel"_meshMotionModel.html, -"meshMotionModel_noMeshMotion"_meshMotionModel_noMeshMotion.html, -"momCoupleModel"_momCoupleModel.html, -"momCoupleModel_explicitCouple"_momCoupleModel_explicitCouple.html, -"momCoupleModel_implicitCouple"_momCoupleModel_implicitCouple.html, -"momCoupleModel_noCouple"_momCoupleModel_noCouple.html, -"probeModel"_probeModel.html, -"probeModel_noProbe"_probeModel_noProbe.html, -"regionModel"_regionModel.html, -"regionModel_allRegion"_regionModel_allRegion.html, -"smoothingModel"_smoothingModel.html, -"smoothingModel_constDiffSmoothing"_smoothingModel_constDiffSmoothing.html, -"smoothingModel_noSmoothing"_smoothingModel_noSmoothing.html, -"voidfractionModel"_voidFractionModel.html, -"voidfractionModel_GaussVoidFraction"_voidFractionModel_GaussVoidFraction.html, -"voidfractionModel_IBVoidFraction"_voidFractionModel_IBVoidFraction.html, -"voidfractionModel_bigParticleVoidFraction"_voidFractionModel_bigParticleVoidFraction.html, -"voidfractionModel_centreVoidFraction"_voidFractionModel_centreVoidFraction.html, -"voidfractionModel_dividedVoidFraction"_voidFractionModel_dividedVoidFraction.html :tb(c=2,ea=c) \ No newline at end of file diff --git a/doc/COPYING b/doc/COPYING index de2dcce..8de0f85 100644 --- a/doc/COPYING +++ b/doc/COPYING @@ -1,678 +1,12 @@ ------------------------------------------------------------------------- - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. +Copyright of the CFDEM®coupling documentation¶: - Preamble +The text and the images of the CFDEM®coupling documentation are - The GNU General Public License is a free, copyleft license for -software and other kinds of works. + Copyright 2009-2012 JKU Linz + Copyright 2012- DCS Computing GmbH, Linz - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 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 General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. ------------------------------------------------------------------------- diff --git a/doc/DISCLAIMER b/doc/DISCLAIMER deleted file mode 100644 index 2736dfc..0000000 --- a/doc/DISCLAIMER +++ /dev/null @@ -1,10 +0,0 @@ -This software is not approved or endorsed by Silicon Graphics International Corp. or the OpenFOAM® Foundation, the producer of the OpenFOAM® software and owner of the OpenFOAM® trade mark. - -Detailed information on the OpenFOAM trademark can be found at - - - http://www.openfoam.com/legal/trademark-policy.php - - http://www.openfoam.com/legal/trademark-guidelines.php - -For further information on OpenCFD and OpenFOAM, please refer to - - - http://www.openfoam.com diff --git a/doc/IOModel.txt b/doc/IOModel.txt deleted file mode 100644 index 77014da..0000000 --- a/doc/IOModel.txt +++ /dev/null @@ -1,36 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -IOModel command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -IOModel "model"; :pre - -model = name of IO-model to be applied :ul - -[Examples:] - -IOModel "off"; - -Note: This examples list might not be complete - please look for other models (IOModel_XY) in this documentation. - -[Description:] - -The IO-model is the base class to write data (e.g. particle properties) to files. - -[Restrictions:] - -none. - -[Related commands:] - -Note: This examples list may be incomplete - please look for other models (IOModel_XY) in this documentation. - -[Default:] none. diff --git a/doc/IOModel_basicIO.txt b/doc/IOModel_basicIO.txt deleted file mode 100644 index 98daa37..0000000 --- a/doc/IOModel_basicIO.txt +++ /dev/null @@ -1,29 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -IOModel_basicIO command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -IOModel "basicIO"; :pre - -[Examples:] - -IOModel "basicIO"; :pre - -[Description:] - -The basic IO-model writes particle positions velocities and radii to files. The default output directory ($casePath/CFD/proc*/time/lagrangian). Using the keyword "serialOutput;" in couplingProperties the IO is serial to the directory ($casePath/CFD/lagrangian). In the latter case only the data on processor 0 is written! Data is written every write time of the CFD simulation. - -[Restrictions:] None. - -[Related commands:] - -"IOModel"_IOModel.html - diff --git a/doc/IOModel_noIO.txt b/doc/IOModel_noIO.txt deleted file mode 100644 index d90d77c..0000000 --- a/doc/IOModel_noIO.txt +++ /dev/null @@ -1,29 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -IOModel_noIO command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -IOModel "off"; :pre - -[Examples:] - -IOModel "off"; :pre - -[Description:] - -The noIO-model is a dummy IO model. - -[Restrictions:] None. - -[Related commands:] - -"IOModel"_IOModel.html - diff --git a/doc/IOModel_sophIO.txt b/doc/IOModel_sophIO.txt deleted file mode 100644 index 09dcd3e..0000000 --- a/doc/IOModel_sophIO.txt +++ /dev/null @@ -1,29 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -IOModel_sophIO command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -IOModel "sophIO"; :pre - -[Examples:] - -IOModel "sophIO"; :pre - -[Description:] - -The sophIO-model is based on basicIO model and additionally writes voidfraction, implicit forces, explicit forces. Data is written every write time of the CFD simulation. - -[Restrictions:] None. - -[Related commands:] - -"IOModel"_IOModel.html - diff --git a/doc/IOModel_trackIO.txt b/doc/IOModel_trackIO.txt deleted file mode 100644 index dff7906..0000000 --- a/doc/IOModel_trackIO.txt +++ /dev/null @@ -1,29 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -IOModel_trackIO command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -IOModel "trackIO"; :pre - -[Examples:] - -IOModel "trackIO"; :pre - -[Description:] - -The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks utility generates tracks of the particles and writes them to a vtk file. - -[Restrictions:] None. - -[Related commands:] - -"IOModel"_IOModel.html - diff --git a/doc/averagingModel.html b/doc/averagingModel.html index 5237b6d..4ac82b3 100644 --- a/doc/averagingModel.html +++ b/doc/averagingModel.html @@ -22,7 +22,7 @@ 
averagingModel dense;
 averagingModel dilute;
-

Note: This examples list might not be complete - please look for other averaging models (averagingModel_XY) in this documentation. +

Note: This examples list might not be complete - please have a look for other averaging models (averagingModel_XY) in this documentation.

Description:

diff --git a/doc/averagingModel.txt b/doc/averagingModel.txt deleted file mode 100644 index 36c327e..0000000 --- a/doc/averagingModel.txt +++ /dev/null @@ -1,37 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -averagingModel command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -averagingModel model; :pre - -model = name of averaging model to be applied :ul - -[Examples:] - -averagingModel dense; -averagingModel dilute; :pre - -Note: This examples list might not be complete - please look for other averaging models (averagingModel_XY) in this documentation. - -[Description:] - -The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). - -[Restrictions:] - -None. - -[Related commands:] - -"dense"_averagingModel_dense.html, "dilute"_averagingModel_dilute.html - -[Default:] none diff --git a/doc/averagingModel_dense.txt b/doc/averagingModel_dense.txt deleted file mode 100644 index 52da602..0000000 --- a/doc/averagingModel_dense.txt +++ /dev/null @@ -1,31 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -averagingModel_dense command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -averagingModel dense; :pre - -[Examples:] - -averagingModel dense; :pre - -[Description:] - -The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). In the "cfdemParticle cloud" this averaging model is used to calculate the average particle velocity inside a CFD cell. The "dense" model is supposed to be applied to cases where the granular regime is rather dense. - -[Restrictions:] - -No known restrictions. - -[Related commands:] - -"averagingModel"_averagingModel.html, "dilute"_averagingModel_dilute.html - diff --git a/doc/averagingModel_dilute.txt b/doc/averagingModel_dilute.txt deleted file mode 100644 index 56640de..0000000 --- a/doc/averagingModel_dilute.txt +++ /dev/null @@ -1,32 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -averagingModel_dilute command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -averagingModel dilute; :pre - -[Examples:] - -averagingModel dilute; :pre - -[Description:] - -The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). -In the "cfdemParticle cloud" this averaging model is used to calculate the average particle velocity inside a CFD cell. The "dilute" model is supposed to be applied to cases where the granular regime is rather dilute. The particle velocity inside a CFD cell is evaluated from a single particle in a cell (no averaging). - -[Restrictions:] - -This model is computationally efficient, but should only be used when only one particle is inside one CFD cell. - -[Related commands:] - -"averagingModel"_averagingModel.html, "dense"_averagingModel_dense.html - diff --git a/doc/cfdemSolverIB.html b/doc/cfdemSolverIB.html index 556d244..70a9f1c 100644 --- a/doc/cfdemSolverIB.html +++ b/doc/cfdemSolverIB.html @@ -46,7 +46,7 @@ the dynamics between immersed bodies and the surrounding fluid. Being an impleme

-

(*) OpenFOAM(R) is a registered trade mark of Silicon Graphics International Corp. This offering is not affiliated, approved or endorsed by Silicon Graphics International Corp., the producer of the OpenFOAM(R) software and owner of the OpenFOAM(R) trademark. +

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.

diff --git a/doc/cfdemSolverIB.txt b/doc/cfdemSolverIB.txt deleted file mode 100644 index 4bb7c2a..0000000 --- a/doc/cfdemSolverIB.txt +++ /dev/null @@ -1,44 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -cfdemSolverIB command :h3 - -[Description:] - -"cfdemSolverIB" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework, for calculating -the dynamics between immersed bodies and the surrounding fluid. Being an implementation of an immersed boundary method it allows tackling problems where the body diameter exceeds the maximal size of a fluid cell. Using the toolbox of OpenFOAM(R)(*) the governing equations of the fluid are computed and the corrections of velocity and pressure field with respect to the body-movement information, gained from LIGGGHTS, are incorporated. - -Code of this solver contributions by Alice Hager, JKU. - -[Algorithm:] - -For each time step ... - -the motion of the spheres is calculated (position, velocity, angular velocity, force...) with LIGGGHTS using the velocity and pressure-field from the previous time step (initial condition for t=0). :ulb,l -the Navier-Stokes equations are solved on the whole computational domain, disregarding the solid phase. :l -the spheres are located within the mesh: each sphere is represented by a cluster of cells, which are either totally or partially covered by the body, depending on its exact position. :l -the correction of the velocity and pressure field of the fluid phase takes place, using the information about the location of the spheres and their (angular) velocity. :l -:ule - -[Use:] - -The solver is realized within the Open Source framework CFDEMcoupling. Just as for the unresolved CFD-DEM solver cfdemSolverPiso the file CFD/constant/couplingProperties contains information about the settings for the different models. While IOmodel, DataExchangeModel etc. are applicable for all CFDEMcoupling-solvers, special locate-, force- and void fraction models were designed for the present case: - -"engineSearchIB"_locateModel_engineSearchIB.html, "ArchimedesIB"_forceModel_ArchimedesIB.html, "ShirgaonkarIB"_forceModel_ShirgaonkarIB.html, "IBVoidfraction"_voidFractionModel_IBVoidFraction.html - -[References:] - -GONIVA, C., KLOSS, C., HAGER,A., WIERINK, G. and PIRKER, S. (2011): "A MULTI-PURPOSE OPEN SOURCE CFD-DEM APPROACH", Proc. of the 8th Int. Conf. on CFD in Oil and Gas, Metallurgical and Process Industries, Trondheim, Norway - -and - -HAGER, A., KLOSS, C. and GONIVA, C. (2011): "TOWARDS AN EFFICIENT IMMERSED BOUNDARY METHOD WITHIN AN OPEN SOURCE FRAMEWORK", Proc. of the 8th Int. Conf. on CFD in Oil and Gas, Metallurgical and Process Industries, Trondheim, Norway - -:line -(*) "OpenFOAM(R)"_of is a registered trade mark of Silicon Graphics International Corp. This offering is not affiliated, approved or endorsed by Silicon Graphics International Corp., the producer of the OpenFOAM(R) software and owner of the OpenFOAM(R) trademark. - -:line diff --git a/doc/cfdemSolverPiso.html b/doc/cfdemSolverPiso.html index dda4059..f517f0e 100644 --- a/doc/cfdemSolverPiso.html +++ b/doc/cfdemSolverPiso.html @@ -19,7 +19,7 @@

-

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks. OPENFOAM® is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group. +

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.

diff --git a/doc/cfdemSolverPiso.txt b/doc/cfdemSolverPiso.txt deleted file mode 100644 index 3885699..0000000 --- a/doc/cfdemSolverPiso.txt +++ /dev/null @@ -1,24 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -cfdemSolverPiso command :h3 - -[Description:] - -"cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), a finite volume based solver for turbulent Navier-Stokes equations applying the PISO algorithm, "cfdemSolverPiso" has additional functionality for a coupling to the DEM code "LIGGGHTS". The volume averaged Navier-Stokes Equations are solved accounting for momentum exchange and volume displacement of discrete particles whose trajectories are calculated in the DEM code LIGGGHTS. - -see: - -GONIVA, C., KLOSS, C., HAGER,A. and PIRKER, S. (2010): "An Open Source CFD-DEM Perspective", Proc. of OpenFOAM Workshop, Göteborg, June 22.-24. - - - - -:line -(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks. OPENFOAM® is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group. - -:line diff --git a/doc/cfdemSolverPisoScalar.html b/doc/cfdemSolverPisoScalar.html index 191cd84..3732a72 100644 --- a/doc/cfdemSolverPisoScalar.html +++ b/doc/cfdemSolverPisoScalar.html @@ -21,7 +21,7 @@

-

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks. OPENFOAM® is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group. +

(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.

diff --git a/doc/cfdemSolverPisoScalar.txt b/doc/cfdemSolverPisoScalar.txt deleted file mode 100644 index f05ca93..0000000 --- a/doc/cfdemSolverPisoScalar.txt +++ /dev/null @@ -1,25 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -cfdemSolverPisoScalar command :h3 - -[Description:] - -"cfdemSolverPisoScalar" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), a finite volume based solver for turbulent Navier-Stokes equations applying PISO algorithm, "cfdemSolverPisoScalar" has additional functionality for a coupling to the DEM code "LIGGGHTS" as well as a scalar transport equation. The volume averaged Navier-Stokes Equations are solved accounting for momentum exchange and volume displacement of discrete particles, whose trajectories are calculated in the DEM code LIGGGHTS. The scalar transport equation is coupled to scalar properties of the particle phase, thus convective heat transfer in a fluid granular system can be modeled with "cfdemSolverPisoScalar". - -see: - -GONIVA, C., KLOSS, C., HAGER,A. and PIRKER, S. (2010): "An Open Source CFD-DEM Perspective", Proc. of OpenFOAM Workshop, Göteborg, June 22.-24. - -The heat transfer equation is implemented according to Nield & Bejan (2013), Convection in Porous Media, DOI 10.1007/978-1-4614-5541-7_2, Springer - - - -:line -(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks. OPENFOAM® is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group. - -:line diff --git a/doc/clockModel.txt b/doc/clockModel.txt deleted file mode 100644 index fa93276..0000000 --- a/doc/clockModel.txt +++ /dev/null @@ -1,32 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -clockModel command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -clockModel model; :pre - -model = name of the clockModel to be applied :ul - -[Examples:] - -clockModel standardClock; :pre - -Note: This examples list might not be complete - please look for other models (clockModel_XY) in this documentation. - -[Description:] - -The clockModel is the base class for models to examine the code/algorithm with respect to run time. - -Main parts of the clockModel classes are written by Josef Kerbl, JKU. - -[Restrictions:] none. - -[Default:] none. diff --git a/doc/clockModel_noClock.txt b/doc/clockModel_noClock.txt deleted file mode 100644 index 509c0b6..0000000 --- a/doc/clockModel_noClock.txt +++ /dev/null @@ -1,29 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -clockModel_noClock command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -clockModel off; :pre - -[Examples:] - -clockModel off; :pre - -[Description:] - -The "noClock" model is a dummy clockModel model which does not measure/evaluate the run time. - -[Restrictions:] none. - -[Related commands:] - -"clockModel"_clockModel.html - diff --git a/doc/clockModel_standardClock.txt b/doc/clockModel_standardClock.txt deleted file mode 100644 index bae9832..0000000 --- a/doc/clockModel_standardClock.txt +++ /dev/null @@ -1,31 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -clockModel_standardClock command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -clockModel standardClock; :pre - -[Examples:] - -clockModel standardClock; :pre - -[Description:] - -The "standardClock" model is a basic clockModel model which measures the run time between every ".start(int arrayPos,string name)" and ".stop(string name)" statement placed in the code. If a ".start(name)" is called more than once (e.g. in a loop) the accumulated times are calculated. After the simulation has finished, the data is stored in $caseDir/CFD/clockData/$startTime/*.txt . -Since the measurements are stored in an array, it is necessary to put a variable {arrayPos} (type integer) at the start command. Those do not need to be in ascending order and positions may be omitted. The standard size of this array is 30 and can be changed at the initialization of the standardClock class. If {arrayPos} is out of bounds, the array size will be doubled. The stop command does not need {arrayPos}, since the class remembers the positions. The string name is intended for easier evaluation afterwards an may be omitted like ".start(int arrayPos)" and ".stop()". The command ".stop(string name)" is a safety feature, because if the name is not equal to the started name, output will be produced for information. -After the case ran you may use the matPlot.py script located in $CFDEM_UT_DIR/vizClock/ to produce a graphical output of your measurements. The usage is like 'python < matPlot.py' and you have to be in the directory of the desired time step, where there is a file called "timeEvalFull.txt", which contains averaged and maximum data with respect to the number of processes. There is an alias called "vizClock" to run this python routine for visualizing the data. - -[Restrictions:] none. - -[Related commands:] - -"clockModel"_clockModel.html - diff --git a/doc/dataExchangeModel.txt b/doc/dataExchangeModel.txt deleted file mode 100644 index 42e0638..0000000 --- a/doc/dataExchangeModel.txt +++ /dev/null @@ -1,37 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -dataExchangeModel command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -dataExchangeModel model; :pre - -model = name of data exchange model to be applied :ul - -[Examples:] - -dataExchangeModel twoWayFiles; -dataExchangeModel twoWayMPI; :pre - -Note: This examples list might not be complete - please look for other models (dataExchangeModel_XY) in this documentation. - -[Description:] - -The data exchange model performs the data exchange between the DEM code and the CFD code. - -[Restrictions:] - -None. - -[Related commands:] - -"noDataExchange"_dataExchangeModel_noDataExchange.html, "oneWayVTK"_dataExchangeModel_oneWayVTK.html, "twoWayFiles"_dataExchangeModel_twoWayFiles.html, "twoWayMPI"_dataExchangeModel_twoWayMPI.html - -[Default:] none diff --git a/doc/dataExchangeModel_noDataExchange.txt b/doc/dataExchangeModel_noDataExchange.txt deleted file mode 100644 index ee6db03..0000000 --- a/doc/dataExchangeModel_noDataExchange.txt +++ /dev/null @@ -1,31 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -dataExchangeModel_noDataExchange command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -dataExchangeModel noDataExchange; :pre - -[Examples:] - -dataExchangeModel noDataExchange; :pre - -[Description:] - -The data exchange model performs the data exchange between the DEM code and the CFD code. The noDataExchange model is a dummy model where no data is exchanged. - -[Restrictions:] - -None. - -[Related commands:] - -"dataExchangeModel"_dataExchangeModel.html - diff --git a/doc/dataExchangeModel_oneWayVTK.txt b/doc/dataExchangeModel_oneWayVTK.txt deleted file mode 100644 index 3cf6642..0000000 --- a/doc/dataExchangeModel_oneWayVTK.txt +++ /dev/null @@ -1,51 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -dataExchangeModel_oneWayVTK command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -dataExchangeModel oneWayVTK; -oneWayVTKProps -\{ - DEMts timeStep; - relativePath "path"; - couplingFilename "filename"; - maxNumberOfParticles number; -\}; :pre - -{timeStep} = time step size of stored DEM data :ulb,l -{path} = path to the VTK data files relative do simulation directory :l -{filename} = filename of the VTK file series :l -{number} = maximum number of particles in DEM simulation :l -:ule - -[Examples:] - -dataExchangeModel oneWayVTK; -oneWayVTKProps -\{ - DEMts 0.0001; - relativePath "../DEM/post"; - couplingFilename "vtk_out%4.4d.vtk"; - maxNumberOfParticles 30000; -\} :pre - -[Description:] - -The data exchange model performs the data exchange between the DEM code and the CFD code. The oneWayVTK model is a model that can exchange particle properties from DEM to CFD based on previously stored VTK data. - -[Restrictions:] - -None. - -[Related commands:] - -"dataExchangeModel"_dataExchangeModel.html - diff --git a/doc/dataExchangeModel_twoWayFiles.txt b/doc/dataExchangeModel_twoWayFiles.txt deleted file mode 100644 index cd31b16..0000000 --- a/doc/dataExchangeModel_twoWayFiles.txt +++ /dev/null @@ -1,45 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -dataExchangeModel_twoWayFiles command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -dataExchangeModel twoWayFiles; -twoWayFilesProps -\{ - couplingFilename "filename"; - maxNumberOfParticles number; -\}; :pre - -{filename} = filename of the VTK file series :ulb,l -{number} = maximum number of particles in DEM simulation :l -:ule - -[Examples:] - -dataExchangeModel twoWayFiles; -twoWayFilesProps -\{ - couplingFilename "vtk_out%4.4d.vtk"; - maxNumberOfParticles 30000; -\} :pre - -[Description:] - -The data exchange model performs the data exchange between the DEM code and the CFD code. The twoWayFiles model is a model that can exchange particle properties from DEM to CFD and from CFD to DEM. Data is exchanged via files that are sequentially written/read by the codes. - -[Restrictions:] - -Developed only for two processors, one for DEM and one for CFD run. - -[Related commands:] - -"dataExchangeModel"_dataExchangeModel.html - diff --git a/doc/dataExchangeModel_twoWayMPI.txt b/doc/dataExchangeModel_twoWayMPI.txt deleted file mode 100644 index f698b0e..0000000 --- a/doc/dataExchangeModel_twoWayMPI.txt +++ /dev/null @@ -1,42 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) - -:line - -dataExchangeModel_twoWayMPI command :h3 - -[Syntax:] - -Defined in couplingProperties dictionary. - -dataExchangeModel twoWayMPI; -twoWayMPIProps -\{ - liggghtsPath "path"; -\}; :pre - -{path} = path to the DEM simulation input file :ulb,l -:ule - -[Examples:] - -dataExchangeModel twoWayMPI; -twoWayMPIProps -\{ - liggghtsPath "../DEM/in.liggghts_init"; -\} :pre - -[Description:] - -The data exchange model performs the data exchange between the DEM code and the CFD code. The twoWayMPI model is a model that can exchange particle properties from DEM to CFD and from CFD to DEM. Data is exchanged via MPI technique. The DEM run is executed by the coupling model, via a liggghtsCommandModel object. - -[Restrictions:] - -none. - -[Related commands:] - -"dataExchangeModel"_dataExchangeModel.html - diff --git a/doc/doxygen/confFile b/doc/doxygen/confFile index 34c3731..74c98e7 100644 --- a/doc/doxygen/confFile +++ b/doc/doxygen/confFile @@ -31,7 +31,7 @@ PROJECT_NAME = CFDEMcoupling # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 2.4 +PROJECT_NUMBER = 2.4.18 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. @@ -574,7 +574,8 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = /home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle +#INPUT = /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-src/lagrangian/cfdemParticle +INPUT = /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/doc/doxygen/html/ArchimedesIB_8H_source.html b/doc/doxygen/html/ArchimedesIB_8H_source.html new file mode 100644 index 0000000..25b062f --- /dev/null +++ b/doc/doxygen/html/ArchimedesIB_8H_source.html @@ -0,0 +1,215 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/forceModel/ArchimedesIB/ArchimedesIB.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
ArchimedesIB.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  ArchimedesIB buoyancy force for sphere / cylinder (2d)
+
32  basic "on-off" handling of buoyancy at the interface
+
33 
+
34  Contribution by Alice Hager.
+
35 
+
36 Class
+
37  ArchimedesIB
+
38 
+
39 SourceFiles
+
40  ArchimedesIB.C
+
41 
+
42 \*---------------------------------------------------------------------------*/
+
43 
+
44 #ifndef ArchimedesIB_H
+
45 #define ArchimedesIB_H
+
46 
+
47 #include "forceModel.H"
+
48 
+
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
50 
+
51 namespace Foam
+
52 {
+
53 
+
54 /*---------------------------------------------------------------------------*\
+
55  Class ArchimedesIB Declaration
+
56 \*---------------------------------------------------------------------------*/
+
57 
+
58 class ArchimedesIB
+
59 :
+
60  public forceModel
+
61 {
+
62 private:
+
63 
+
64  dictionary propsDict_;
+
65 
+
66  bool twoDimensional_;
+
67 
+
68  word voidfractionFieldName_;
+
69 
+
70  const volScalarField& voidfractions_;
+
71 
+
72  word gravityFieldName_;
+
73 
+
74  #ifdef version21
+
75  const uniformDimensionedVectorField& g_; // ref to gravity
+
76  #elif defined(version16ext) || defined(version15)
+
77  const dimensionedVector& g_; // ref to gravity
+
78  #endif
+
79 
+
80 
+
81 public:
+
82 
+
83  //- Runtime type information
+
84  TypeName("ArchimedesIB");
+
85 
+
86 
+
87  // Constructors
+
88 
+
89  //- Construct from components
+
90  ArchimedesIB
+
91  (
+
92  const dictionary& dict,
+
93  cfdemCloud& sm
+
94  );
+
95 
+
96  // Destructor
+
97 
+
98  ~ArchimedesIB();
+
99 
+
100 
+
101  // Member Functions
+
102  void setForce() const;
+
103 };
+
104 
+
105 
+
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
107 
+
108 } // End namespace Foam
+
109 
+
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
111 
+
112 #endif
+
113 
+
114 // ************************************************************************* //
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::forceModel
Definition: forceModel.H:55
+
Foam::ArchimedesIB
Definition: ArchimedesIB.H:58
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/Archimedes_8H_source.html b/doc/doxygen/html/Archimedes_8H_source.html new file mode 100644 index 0000000..9c5e7dd --- /dev/null +++ b/doc/doxygen/html/Archimedes_8H_source.html @@ -0,0 +1,209 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/forceModel/Archimedes/Archimedes.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
Archimedes.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  Archimedes buoyancy force for sphere / cylinder (2d)
+
32  basic "on-off" handling of buoyancy at the interface
+
33 
+
34 Class
+
35  Archimedes
+
36 
+
37 SourceFiles
+
38  Archimedes.C
+
39 
+
40 \*---------------------------------------------------------------------------*/
+
41 
+
42 #ifndef Archimedes_H
+
43 #define Archimedes_H
+
44 
+
45 #include "forceModel.H"
+
46 
+
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
48 
+
49 namespace Foam
+
50 {
+
51 
+
52 /*---------------------------------------------------------------------------*\
+
53  Class Archimedes Declaration
+
54 \*---------------------------------------------------------------------------*/
+
55 
+
56 class Archimedes
+
57 :
+
58  public forceModel
+
59 {
+
60 private:
+
61 
+
62  dictionary propsDict_;
+
63 
+
64  bool twoDimensional_;
+
65 
+
66  word gravityFieldName_;
+
67 
+
68  #ifdef version21
+
69  const uniformDimensionedVectorField& g_; // ref to gravity
+
70  #elif defined(version16ext) || defined(version15)
+
71  const dimensionedVector& g_; // ref to gravity
+
72  #endif
+
73 
+
74 
+
75 public:
+
76 
+
77  //- Runtime type information
+
78  TypeName("Archimedes");
+
79 
+
80 
+
81  // Constructors
+
82 
+
83  //- Construct from components
+
84  Archimedes
+
85  (
+
86  const dictionary& dict,
+
87  cfdemCloud& sm
+
88  );
+
89 
+
90  // Destructor
+
91 
+
92  ~Archimedes();
+
93 
+
94 
+
95  // Member Functions
+
96  void setForce() const;
+
97 };
+
98 
+
99 
+
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
101 
+
102 } // End namespace Foam
+
103 
+
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
105 
+
106 #endif
+
107 
+
108 // ************************************************************************* //
+
Foam::Archimedes
Definition: Archimedes.H:56
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::forceModel
Definition: forceModel.H:55
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/DiFeliceDrag_8H_source.html b/doc/doxygen/html/DiFeliceDrag_8H_source.html new file mode 100644 index 0000000..1017b62 --- /dev/null +++ b/doc/doxygen/html/DiFeliceDrag_8H_source.html @@ -0,0 +1,213 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/forceModel/DiFeliceDrag/DiFeliceDrag.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
DiFeliceDrag.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  Di Felice drag law (Zhou et al. (2010), JFM)
+
32 
+
33 Class
+
34  DiFeliceDrag
+
35 
+
36 SourceFiles
+
37  DiFeliceDrag.C
+
38 
+
39 \*---------------------------------------------------------------------------*/
+
40 
+
41 #ifndef DiFeliceDrag_H
+
42 #define DiFeliceDrag_H
+
43 
+
44 #include "forceModel.H"
+
45 #include "interpolationCellPoint.H"
+
46 
+
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
48 
+
49 namespace Foam
+
50 {
+
51 
+
52 /*---------------------------------------------------------------------------*\
+
53  Class DiFeliceDrag Declaration
+
54 \*---------------------------------------------------------------------------*/
+
55 
+
56 class DiFeliceDrag
+
57 :
+
58  public forceModel
+
59 {
+
60 private:
+
61  dictionary propsDict_;
+
62 
+
63  word velFieldName_;
+
64 
+
65  const volVectorField& U_;
+
66 
+
67  word voidfractionFieldName_;
+
68 
+
69  const volScalarField& voidfraction_;
+
70 
+
71  word UsFieldName_;
+
72 
+
73  const volVectorField& UsField_; // the average particle velocity field (for implicit/expliti force split)
+
74 
+
75  mutable scalar scaleDia_;
+
76 
+
77  mutable scalar scaleDrag_;
+
78 
+
79 public:
+
80 
+
81  //- Runtime type information
+
82  TypeName("DiFeliceDrag");
+
83 
+
84 
+
85  // Constructors
+
86 
+
87  //- Construct from components
+
88  DiFeliceDrag
+
89  (
+
90  const dictionary& dict,
+
91  cfdemCloud& sm
+
92  );
+
93 
+
94  // Destructor
+
95 
+
96  ~DiFeliceDrag();
+
97 
+
98 
+
99  // Member Functions
+
100  void setForce() const;
+
101 };
+
102 
+
103 
+
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
105 
+
106 } // End namespace Foam
+
107 
+
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
109 
+
110 #endif
+
111 
+
112 // ************************************************************************* //
+
Foam::DiFeliceDrag
Definition: DiFeliceDrag.H:56
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::forceModel
Definition: forceModel.H:55
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/GaussVoidFraction_8H_source.html b/doc/doxygen/html/GaussVoidFraction_8H_source.html new file mode 100644 index 0000000..c1de070 --- /dev/null +++ b/doc/doxygen/html/GaussVoidFraction_8H_source.html @@ -0,0 +1,213 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/voidFractionModel/GaussVoidFraction/GaussVoidFraction.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
GaussVoidFraction.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  Gaussian distributed particle voidfraction model
+
32  contribution from RQ
+
33 
+
34 Class
+
35  GaussVoidFraction
+
36 
+
37 SourceFiles
+
38  GaussVoidFraction.C
+
39 
+
40 \*---------------------------------------------------------------------------*/
+
41 
+
42 #ifndef GaussVoidFraction_H
+
43 #define GaussVoidFraction_H
+
44 
+
45 #include "voidFractionModel.H"
+
46 
+
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
48 
+
49 namespace Foam
+
50 {
+
51 
+
52 /*---------------------------------------------------------------------------*\
+
53  Class noDrag Declaration
+
54 \*---------------------------------------------------------------------------*/
+
55 
+
56 class GaussVoidFraction
+
57 :
+
58  public voidFractionModel
+
59 {
+
60 
+
61 private:
+
62  dictionary propsDict_;
+
63 
+
64  const scalar alphaMin_; //NP min value of voidFraction
+
65 
+
66  mutable bool alphaLimited_;
+
67 
+
68 public:
+
69 
+
70  //- Runtime type information
+
71  TypeName("Gauss");
+
72 
+
73 
+
74  // Constructors
+
75 
+
76  //- Construct from components
+
77  GaussVoidFraction
+
78  (
+
79  const dictionary& dict,
+
80  cfdemCloud& sm
+
81  );
+
82 
+
83  // Destructor
+
84 
+
85  ~GaussVoidFraction();
+
86 
+
87 
+
88  // Member Functions
+
89  void setvoidFraction(double** const& ,double**&, double**&, double**&, double**&) const;
+
90 
+
91  void buildLabelHashSet
+
92  (
+
93  const scalar radius,
+
94  const vector position,
+
95  const label cellID,
+
96  labelHashSet& hashSett
+
97  /*labelHashSet& hashSetComplete,
+
98  labelHashSet& hashSetPartial,
+
99  labelHashSet& hashSetRest*/
+
100  ) const;
+
101 };
+
102 
+
103 
+
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
105 
+
106 } // End namespace Foam
+
107 
+
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
109 
+
110 #endif
+
111 
+
112 // ************************************************************************* //
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::voidFractionModel
Definition: voidFractionModel.H:56
+
Foam::GaussVoidFraction
Definition: GaussVoidFraction.H:56
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/GidaspowDrag_8H_source.html b/doc/doxygen/html/GidaspowDrag_8H_source.html new file mode 100644 index 0000000..d78f192 --- /dev/null +++ b/doc/doxygen/html/GidaspowDrag_8H_source.html @@ -0,0 +1,221 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/forceModel/GidaspowDrag/GidaspowDrag.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
GidaspowDrag.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  Gidaspow drag law
+
32  - only valid for low-Reynolds number systems (Re_p<1000)
+
33  - including interpolation of the velocity to the exact position
+
34  - splits off explicit drag component due to fluctuation in fluid and particle
+
35  velocity (optional via forceSubModel "ImExCorr")
+
36 
+
37 Class
+
38  GidaspowDrag
+
39 
+
40 SourceFiles
+
41  GidaspowDrag.C
+
42 
+
43 \*---------------------------------------------------------------------------*/
+
44 
+
45 #ifndef GidaspowDrag_H
+
46 #define GidaspowDrag_H
+
47 
+
48 #include "forceModel.H"
+
49 #include "interpolationCellPoint.H"
+
50 
+
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
52 
+
53 namespace Foam
+
54 {
+
55 
+
56 /*---------------------------------------------------------------------------*\
+
57  Class GidaspowDrag Declaration
+
58 \*---------------------------------------------------------------------------*/
+
59 
+
60 class GidaspowDrag
+
61 :
+
62  public forceModel
+
63 {
+
64 private:
+
65  dictionary propsDict_;
+
66 
+
67  word velFieldName_;
+
68 
+
69  const volVectorField& U_;
+
70 
+
71  word voidfractionFieldName_;
+
72 
+
73  const volScalarField& voidfraction_;
+
74 
+
75  const scalar phi_;
+
76 
+
77  word UsFieldName_;
+
78 
+
79  const volVectorField& UsField_; // the average particle velocity field
+
80 
+
81  mutable scalar scaleDia_;
+
82 
+
83  mutable scalar scaleDrag_;
+
84 
+
85  mutable scalar switchingVoidfraction_; //voidfraction above which dilute formulation will be used
+
86 
+
87 public:
+
88 
+
89  //- Runtime type information
+
90  TypeName("GidaspowDrag");
+
91 
+
92 
+
93  // Constructors
+
94 
+
95  //- Construct from components
+
96  GidaspowDrag
+
97  (
+
98  const dictionary& dict,
+
99  cfdemCloud& sm
+
100  );
+
101 
+
102  // Destructor
+
103 
+
104  ~GidaspowDrag();
+
105 
+
106 
+
107  // Member Functions
+
108  void setForce() const;
+
109 };
+
110 
+
111 
+
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
113 
+
114 } // End namespace Foam
+
115 
+
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
117 
+
118 #endif
+
119 
+
120 // ************************************************************************* //
+
Foam::GidaspowDrag
Definition: GidaspowDrag.H:60
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::forceModel
Definition: forceModel.H:55
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/IBVoidFraction_8H_source.html b/doc/doxygen/html/IBVoidFraction_8H_source.html new file mode 100644 index 0000000..302821b --- /dev/null +++ b/doc/doxygen/html/IBVoidFraction_8H_source.html @@ -0,0 +1,226 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/voidFractionModel/IBVoidFraction/IBVoidFraction.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
IBVoidFraction.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  void fraction model for the smooth representation of spheres with
+
32  radius > cell length.
+
33  contribution from Alice Hager
+
34 
+
35 Class
+
36  IBVoidFraction
+
37 
+
38 SourceFiles
+
39  IBVoidFraction.C
+
40 
+
41 \*---------------------------------------------------------------------------*/
+
42 
+
43 #ifndef IBVoidFraction_H
+
44 #define IBVoidFraction_H
+
45 
+
46 #include "voidFractionModel.H"
+
47 
+
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
49 
+
50 namespace Foam
+
51 {
+
52 
+
53 /*---------------------------------------------------------------------------*\
+
54  Class noDrag Declaration
+
55 \*---------------------------------------------------------------------------*/
+
56 
+
57 class IBVoidFraction
+
58 :
+
59  public voidFractionModel
+
60 {
+
61 
+
62 private:
+
63  dictionary propsDict_;
+
64 
+
65  const scalar alphaMin_; //NP min value of voidFraction
+
66 
+
67  mutable bool alphaLimited_;
+
68 
+
69  const scalar scaleUpVol_; //NP scaling radius, keeping volume of particle
+
70 
+
71  mutable bool checkPeriodicCells_;
+
72 
+
73 public:
+
74 
+
75  //- Runtime type information
+
76  TypeName("IB");
+
77 
+
78 
+
79  // Constructors
+
80 
+
81  //- Construct from components
+
82  IBVoidFraction
+
83  (
+
84  const dictionary& dict,
+
85  cfdemCloud& sm
+
86  );
+
87 
+
88  // Destructor
+
89 
+
90  ~IBVoidFraction();
+
91 
+
92 
+
93  // Member Functions
+
94  void setvoidFraction(double** const& ,double**&, double**&, double**&, double**&) const;
+
95 
+
96  void buildLabelHashSet
+
97  (
+
98  const scalar radius,
+
99  const vector position,
+
100  const label cellID,
+
101  labelHashSet& hashSett,
+
102  bool initialInsert
+
103  ) const;
+
104 
+
105  double minPeriodicDistance
+
106  (
+
107  vector cellCentrePosition,
+
108  vector positionCenter,
+
109  boundBox globalBb,
+
110  vector& minPeriodicPos
+
111  ) const;
+
112 
+
113 
+
114 };
+
115 
+
116 
+
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
118 
+
119 } // End namespace Foam
+
120 
+
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
122 
+
123 #endif
+
124 
+
125 // ************************************************************************* //
+
Foam::IBVoidFraction
Definition: IBVoidFraction.H:57
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::voidFractionModel
Definition: voidFractionModel.H:56
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/IOModel_8H_source.html b/doc/doxygen/html/IOModel_8H_source.html new file mode 100644 index 0000000..21692ff --- /dev/null +++ b/doc/doxygen/html/IOModel_8H_source.html @@ -0,0 +1,236 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/IOModel/IOModel/IOModel.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
IOModel.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31 Class
+
32  IOModel
+
33 
+
34 SourceFiles
+
35  IOModel.C
+
36 
+
37 \*---------------------------------------------------------------------------*/
+
38 
+
39 #ifndef IOModel_H
+
40 #define IOModel_H
+
41 
+
42 #include "fvCFD.H"
+
43 #include "cfdemCloud.H"
+
44 #include "OFstream.H"
+
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
46 
+
47 namespace Foam
+
48 {
+
49 
+
50 /*---------------------------------------------------------------------------*\
+
51  Class IOModel Declaration
+
52 \*---------------------------------------------------------------------------*/
+
53 
+
54 class IOModel
+
55 {
+
56 
+
57 protected:
+
58 
+
59  // Protected data
+
60  const dictionary& dict_;
+
61 
+
62  cfdemCloud& particleCloud_;
+
63 
+
64  const Time& time_;
+
65 
+
66  bool parOutput_;
+
67 
+
68 public:
+
69 
+
70  //- Runtime type information
+
71  TypeName("IOModel");
+
72 
+
73  // Declare runtime constructor selection table
+
74 
+
75  declareRunTimeSelectionTable
+
76  (
+
77  autoPtr,
+
78  IOModel,
+
79  dictionary,
+
80  (
+
81  const dictionary& dict,
+
82  cfdemCloud& sm
+
83  ),
+
84  (dict,sm)
+
85  );
+
86 
+
87 
+
88  // Constructors
+
89 
+
90  //- Construct from components
+
91  IOModel
+
92  (
+
93  const dictionary& dict,
+
94  cfdemCloud& sm
+
95  );
+
96 
+
97 
+
98  // Destructor
+
99 
+
100  virtual ~IOModel();
+
101 
+
102 
+
103  // Selector
+
104 
+
105  static autoPtr<IOModel> New
+
106  (
+
107  const dictionary& dict,
+
108  cfdemCloud& sm
+
109  );
+
110 
+
111 
+
112  // Member Functions
+
113 
+
114  virtual int dumpDEMdata() const;
+
115 
+
116  bool dumpNow() const;
+
117 
+
118  fileName createTimeDir(fileName) const;
+
119 
+
120  fileName createLagrangianDir(fileName) const;
+
121 
+
122  fileName buildFilePath(word) const;
+
123 
+
124  void streamDataToPath(fileName,double**,int,word,word type,word className,word finaliser) const;
+
125 };
+
126 
+
127 
+
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
129 
+
130 } // End namespace Foam
+
131 
+
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
133 
+
134 #endif
+
135 
+
136 // ************************************************************************* //
+
Foam::IOModel
Definition: IOModel.H:54
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/ImEx_8H_source.html b/doc/doxygen/html/ImEx_8H_source.html new file mode 100644 index 0000000..ae95e82 --- /dev/null +++ b/doc/doxygen/html/ImEx_8H_source.html @@ -0,0 +1,197 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/forceModel/forceSubModels/ImEx/ImEx.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
ImEx.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31 Class
+
32  ImEx
+
33 
+
34 SourceFiles
+
35  ImEx.C
+
36 
+
37 \*---------------------------------------------------------------------------*/
+
38 
+
39 #ifndef ImEx_H
+
40 #define ImEx_H
+
41 
+
42 #include "forceSubModel.H"
+
43 
+
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
45 
+
46 namespace Foam
+
47 {
+
48 
+
49 /*---------------------------------------------------------------------------*\
+
50  Class ImEx Declaration
+
51 \*---------------------------------------------------------------------------*/
+
52 
+
53 class ImEx
+
54 :
+
55  public forceSubModel
+
56 {
+
57 private:
+
58 
+
59 
+
60 public:
+
61 
+
62  //- Runtime type information
+
63  TypeName("ImEx");
+
64 
+
65 
+
66  // Constructors
+
67 
+
68  //- Construct from components
+
69  ImEx
+
70  (
+
71  const dictionary& dict,
+
72  cfdemCloud& sm,
+
73  forceModel& fm
+
74  );
+
75 
+
76  // Destructor
+
77 
+
78  ~ImEx();
+
79 
+
80 
+
81  // Member Functions
+
82 
+
83  word myType() const{return typeName; };
+
84 };
+
85 
+
86 
+
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
88 
+
89 } // End namespace Foam
+
90 
+
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
92 
+
93 #endif
+
94 
+
95 // ************************************************************************* //
+
Foam::ImEx
Definition: ImEx.H:53
+
Foam::forceSubModel
Definition: forceSubModel.H:54
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::forceModel
Definition: forceModel.H:55
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/KochHillDrag_8H_source.html b/doc/doxygen/html/KochHillDrag_8H_source.html new file mode 100644 index 0000000..af4e9e5 --- /dev/null +++ b/doc/doxygen/html/KochHillDrag_8H_source.html @@ -0,0 +1,217 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/forceModel/KochHillDrag/KochHillDrag.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
KochHillDrag.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  Koch, Hill drag law
+
32  based on Koch Hill 2001,"Inertial effects in suspensions and porous-media
+
33  flows", Annual Review of fluid mechanics.
+
34  including interpolation of the velocity to the exact position
+
35  including drag coefficient for implicit drag for DEM
+
36 
+
37 Class
+
38  KochHillDrag
+
39 
+
40 SourceFiles
+
41  KochHillDrag.C
+
42 
+
43 \*---------------------------------------------------------------------------*/
+
44 
+
45 #ifndef KochHillDrag_H
+
46 #define KochHillDrag_H
+
47 
+
48 #include "forceModel.H"
+
49 #include "interpolationCellPoint.H"
+
50 
+
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
52 
+
53 namespace Foam
+
54 {
+
55 
+
56 /*---------------------------------------------------------------------------*\
+
57  Class KochHillDrag Declaration
+
58 \*---------------------------------------------------------------------------*/
+
59 
+
60 class KochHillDrag
+
61 :
+
62  public forceModel
+
63 {
+
64 private:
+
65  dictionary propsDict_;
+
66 
+
67  word velFieldName_;
+
68 
+
69  const volVectorField& U_;
+
70 
+
71  word voidfractionFieldName_;
+
72 
+
73  const volScalarField& voidfraction_;
+
74 
+
75  word UsFieldName_;
+
76 
+
77  const volVectorField& UsField_;
+
78 
+
79  mutable scalar scaleDia_;
+
80 
+
81  mutable scalar scaleDrag_;
+
82 
+
83 public:
+
84 
+
85  //- Runtime type information
+
86  TypeName("KochHillDrag");
+
87 
+
88 
+
89  // Constructors
+
90 
+
91  //- Construct from components
+
92  KochHillDrag
+
93  (
+
94  const dictionary& dict,
+
95  cfdemCloud& sm
+
96  );
+
97 
+
98  // Destructor
+
99 
+
100  ~KochHillDrag();
+
101 
+
102 
+
103  // Member Functions
+
104  void setForce() const;
+
105 };
+
106 
+
107 
+
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
109 
+
110 } // End namespace Foam
+
111 
+
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
113 
+
114 #endif
+
115 
+
116 // ************************************************************************* //
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::forceModel
Definition: forceModel.H:55
+
Foam::KochHillDrag
Definition: KochHillDrag.H:60
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/LaEuScalarTemp_8H_source.html b/doc/doxygen/html/LaEuScalarTemp_8H_source.html new file mode 100644 index 0000000..cefc5b2 --- /dev/null +++ b/doc/doxygen/html/LaEuScalarTemp_8H_source.html @@ -0,0 +1,231 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/forceModel/LaEuScalarTemp/LaEuScalarTemp.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
LaEuScalarTemp.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  two way LaEu Scalar Exchange between DEM and CFD
+
32  convective heat transfer model following
+
33  Li and Mason (2000), A computational investigation of transient heat
+
34  transfer in pneumatic transport of granular particles, Pow.Tech 112
+
35 
+
36 Class
+
37  LaEuScalarTemp
+
38 
+
39 SourceFiles
+
40  LaEuScalarTemp.C
+
41 
+
42 \*---------------------------------------------------------------------------*/
+
43 
+
44 #ifndef LaEuScalarTemp_H
+
45 #define LaEuScalarTemp_H
+
46 
+
47 #include "forceModel.H"
+
48 #include "averagingModel.H"
+
49 #include "interpolationCellPoint.H"
+
50 
+
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
52 
+
53 namespace Foam
+
54 {
+
55 
+
56 /*---------------------------------------------------------------------------*\
+
57  Class LaEuScalarTemp Declaration
+
58 \*---------------------------------------------------------------------------*/
+
59 
+
60 class LaEuScalarTemp
+
61 :
+
62  public forceModel
+
63 {
+
64 private:
+
65 
+
66  dictionary propsDict_;
+
67 
+
68  word tempFieldName_;
+
69 
+
70  const volScalarField& tempField_; // ref to temperature field
+
71 
+
72  word voidfractionFieldName_;
+
73 
+
74  const volScalarField& voidfraction_; // ref to voidfraction field
+
75 
+
76  scalar maxSource_; // max (limited) value of src field
+
77 
+
78  word velFieldName_;
+
79 
+
80  const volVectorField& U_;
+
81 
+
82  word partTempName_;
+
83 
+
84  mutable double **partTemp_; // Lagrangian array
+
85 
+
86  word partHeatFluxName_;
+
87 
+
88  mutable double **partHeatFlux_; // Lagrangian array
+
89 
+
90  scalar lambda_; // fluid thermal conductivity [W/(m*K)]
+
91 
+
92  scalar Cp_; // specific heat capacity [W*s/(kg*K)]
+
93 
+
94  void allocateMyArrays() const;
+
95 
+
96 public:
+
97 
+
98  //- Runtime type information
+
99  TypeName("LaEuScalarTemp");
+
100 
+
101  // Constructors
+
102 
+
103  //- Construct from components
+
104  LaEuScalarTemp
+
105  (
+
106  const dictionary& dict,
+
107  cfdemCloud& sm
+
108  );
+
109 
+
110  // Destructor
+
111 
+
112  ~LaEuScalarTemp();
+
113 
+
114 
+
115  // Member Functions
+
116  void setForce() const;
+
117 
+
118  void manipulateScalarField(volScalarField&) const;
+
119 };
+
120 
+
121 
+
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
123 
+
124 } // End namespace Foam
+
125 
+
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
127 
+
128 #endif
+
129 
+
130 // ************************************************************************* //
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::forceModel
Definition: forceModel.H:55
+
Foam::LaEuScalarTemp
Definition: LaEuScalarTemp.H:60
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/MeiLift_8H_source.html b/doc/doxygen/html/MeiLift_8H_source.html new file mode 100644 index 0000000..ad5974d --- /dev/null +++ b/doc/doxygen/html/MeiLift_8H_source.html @@ -0,0 +1,220 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/forceModel/MeiLift/MeiLift.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
MeiLift.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  This function is based on the derivation in R. Kurose, S. Komori,
+
32  Drag and lift forces on a rotating sphere in a linear shear flow,
+
33  Journal of Fluid Mechanics. 384 (1999) 183-206.
+
34 
+
35  The data for this functions is based on J.B. Mclaughlin,
+
36  Inertial migration of a small sphere in linear shear flows,
+
37  Journal of Fluid Mechanics. 224 (1991) 261-274.
+
38 
+
39  The second order terms are based on:
+
40  Mei Lift force following Loth and Dorgan 2009,
+
41  and can be added to the lift coefficient if desired
+
42  (contribution from RQ)
+
43 
+
44  - including interpolation of the velocity to the particle position (optional)
+
45  - including output to file for testing/data analysis (optional)
+
46 
+
47 
+
48 Class
+
49  MeiLift
+
50 
+
51 SourceFiles
+
52  MeiLift.C
+
53 
+
54 \*---------------------------------------------------------------------------*/
+
55 
+
56 #ifndef MeiLift_H
+
57 #define MeiLift_H
+
58 
+
59 #include "forceModel.H"
+
60 #include "IOList.H"
+
61 #include "interpolationCellPoint.H"
+
62 
+
63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
64 
+
65 namespace Foam
+
66 {
+
67 
+
68 /*---------------------------------------------------------------------------*\
+
69  Class MeiLift Declaration
+
70 \*---------------------------------------------------------------------------*/
+
71 
+
72 class MeiLift
+
73 :
+
74  public forceModel
+
75 {
+
76 private:
+
77  dictionary propsDict_;
+
78 
+
79  word velFieldName_;
+
80 
+
81  const volVectorField& U_;
+
82 
+
83  bool useSecondOrderTerms_;
+
84 
+
85 public:
+
86 
+
87  //- Runtime type information
+
88  TypeName("MeiLift");
+
89 
+
90 
+
91  // Constructors
+
92 
+
93  //- Construct from components
+
94  MeiLift
+
95  (
+
96  const dictionary& dict,
+
97  cfdemCloud& sm
+
98  );
+
99 
+
100  // Destructor
+
101 
+
102  ~MeiLift();
+
103 
+
104 
+
105  // Member Functions
+
106  void setForce() const;
+
107 
+
108 };
+
109 
+
110 
+
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
112 
+
113 } // End namespace Foam
+
114 
+
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
116 
+
117 #endif
+
118 
+
119 // ************************************************************************* //
+
Foam::MeiLift
Definition: MeiLift.H:72
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::forceModel
Definition: forceModel.H:55
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/OFversion_8H_source.html b/doc/doxygen/html/OFversion_8H_source.html new file mode 100644 index 0000000..a759c94 --- /dev/null +++ b/doc/doxygen/html/OFversion_8H_source.html @@ -0,0 +1,115 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
OFversion.H
+
+
+
1 #define version23 // currently being used
+
2 //#define version22
+
3 //#define version21
+
4 //#define version16ext
+
5 //#define version15
+
6 
+
7 // features of 2.1 work also in 2.3
+
8 #if defined(version23)
+
9  #define version21
+
10  #define version221
+
11 #endif
+
12 
+
13 // features of 2.1 work also in 2.2
+
14 #if defined(version22)
+
15  #define version21
+
16  #define version221
+
17 #endif
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/SchillerNaumannDrag_8H_source.html b/doc/doxygen/html/SchillerNaumannDrag_8H_source.html new file mode 100644 index 0000000..737cae1 --- /dev/null +++ b/doc/doxygen/html/SchillerNaumannDrag_8H_source.html @@ -0,0 +1,203 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/forceModel/SchillerNaumannDrag/SchillerNaumannDrag.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
SchillerNaumannDrag.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  Schiller Naumann drag law
+
32  contribution from RQ
+
33 
+
34 Class
+
35  SchillerNaumannDrag
+
36 
+
37 SourceFiles
+
38  SchillerNaumannDrag.C
+
39 
+
40 \*---------------------------------------------------------------------------*/
+
41 
+
42 #ifndef SchillerNaumannDrag_H
+
43 #define SchillerNaumannDrag_H
+
44 
+
45 #include "forceModel.H"
+
46 
+
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
48 
+
49 namespace Foam
+
50 {
+
51 
+
52 /*---------------------------------------------------------------------------*\
+
53  Class SchillerNaumannDrag Declaration
+
54 \*---------------------------------------------------------------------------*/
+
55 
+
56 class SchillerNaumannDrag
+
57 :
+
58  public forceModel
+
59 {
+
60 private:
+
61  dictionary propsDict_;
+
62 
+
63  bool verbose_;
+
64 
+
65  word velFieldName_;
+
66 
+
67  const volVectorField& U_;
+
68 
+
69 public:
+
70 
+
71  //- Runtime type information
+
72  TypeName("SchillerNaumannDrag");
+
73 
+
74 
+
75  // Constructors
+
76 
+
77  //- Construct from components
+
78  SchillerNaumannDrag
+
79  (
+
80  const dictionary& dict,
+
81  cfdemCloud& sm
+
82  );
+
83 
+
84  // Destructor
+
85 
+
86  ~SchillerNaumannDrag();
+
87 
+
88 
+
89  // Member Functions
+
90  void setForce() const;
+
91 };
+
92 
+
93 
+
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
95 
+
96 } // End namespace Foam
+
97 
+
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
99 
+
100 #endif
+
101 
+
102 // ************************************************************************* //
+
Foam::SchillerNaumannDrag
Definition: SchillerNaumannDrag.H:56
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::forceModel
Definition: forceModel.H:55
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/ShirgaonkarIB_8H_source.html b/doc/doxygen/html/ShirgaonkarIB_8H_source.html new file mode 100644 index 0000000..19ce6ff --- /dev/null +++ b/doc/doxygen/html/ShirgaonkarIB_8H_source.html @@ -0,0 +1,211 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/forceModel/ShirgaonkarIB/ShirgaonkarIB.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
ShirgaonkarIB.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  drag law for ficticious domain method calculating: sum(mu*nabla*u-laplace*p)
+
32  contribution from Alice Hager
+
33 
+
34 Class
+
35  ShirgaonkarIB
+
36 
+
37 SourceFiles
+
38  ShirgaonkarIB.C
+
39 
+
40 \*---------------------------------------------------------------------------*/
+
41 
+
42 #ifndef ShirgaonkarIB_H
+
43 #define ShirgaonkarIB_H
+
44 
+
45 #include "forceModel.H"
+
46 
+
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
48 
+
49 namespace Foam
+
50 {
+
51 
+
52 /*---------------------------------------------------------------------------*\
+
53  Class ShirgaonkarIB Declaration
+
54 \*---------------------------------------------------------------------------*/
+
55 
+
56 class ShirgaonkarIB
+
57 :
+
58  public forceModel
+
59 {
+
60 private:
+
61  dictionary propsDict_;
+
62 
+
63  bool verbose_;
+
64 
+
65  bool twoDimensional_;
+
66 
+
67  bool depth_;
+
68 
+
69  word velFieldName_;
+
70 
+
71  const volVectorField& U_;
+
72 
+
73  word pressureFieldName_;
+
74 
+
75  const volScalarField& p_;
+
76 
+
77 public:
+
78 
+
79  //- Runtime type information
+
80  TypeName("ShirgaonkarIB");
+
81 
+
82 
+
83  // Constructors
+
84 
+
85  //- Construct from components
+
86  ShirgaonkarIB
+
87  (
+
88  const dictionary& dict,
+
89  cfdemCloud& sm
+
90  );
+
91 
+
92  // Destructor
+
93 
+
94  ~ShirgaonkarIB();
+
95 
+
96 
+
97  // Member Functions
+
98  void setForce() const;
+
99 };
+
100 
+
101 
+
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
103 
+
104 } // End namespace Foam
+
105 
+
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
107 
+
108 #endif
+
109 
+
110 // ************************************************************************* //
+
Foam::ShirgaonkarIB
Definition: ShirgaonkarIB.H:56
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::forceModel
Definition: forceModel.H:55
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/allRegion_8H_source.html b/doc/doxygen/html/allRegion_8H_source.html new file mode 100644 index 0000000..d62099b --- /dev/null +++ b/doc/doxygen/html/allRegion_8H_source.html @@ -0,0 +1,196 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/regionModel/allRegion/allRegion.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
allRegion.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31 Class
+
32  allRegion
+
33 
+
34 SourceFiles
+
35  allRegion.C
+
36 
+
37 \*---------------------------------------------------------------------------*/
+
38 
+
39 #ifndef allRegion_H
+
40 #define allRegion_H
+
41 
+
42 #include "regionModel.H"
+
43 
+
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
45 
+
46 namespace Foam
+
47 {
+
48 
+
49 /*---------------------------------------------------------------------------*\
+
50  Class noDrag Declaration
+
51 \*---------------------------------------------------------------------------*/
+
52 
+
53 class allRegion
+
54 :
+
55  public regionModel
+
56 {
+
57 
+
58 public:
+
59 
+
60  //- Runtime type information
+
61  TypeName("allRegion");
+
62 
+
63 
+
64  // Constructors
+
65 
+
66  //- Construct from components
+
67  allRegion
+
68  (
+
69  const dictionary& dict,
+
70  cfdemCloud& sm
+
71  );
+
72 
+
73  // Destructor
+
74 
+
75  ~allRegion();
+
76 
+
77 
+
78  // Member Functions
+
79  void defineRegion() const;
+
80 
+
81  void expandRegion(volVectorField&) const;
+
82 
+
83  void resetVolFields(volVectorField&) const;
+
84 };
+
85 
+
86 
+
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
88 
+
89 } // End namespace Foam
+
90 
+
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
92 
+
93 #endif
+
94 
+
95 // ************************************************************************* //
+
Foam::allRegion
Definition: allRegion.H:53
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::regionModel
Definition: regionModel.H:53
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/annotated.html b/doc/doxygen/html/annotated.html index c93f2e8..e652ae8 100644 --- a/doc/doxygen/html/annotated.html +++ b/doc/doxygen/html/annotated.html @@ -1,130 +1,169 @@ - + + CFDEMcoupling: Class List + + - - + + + - - - -
-
-
Generated on Mon Apr 23 19:06:18 2012 for CFDEMcoupling by  - -doxygen 1.6.3
+
+
+
Class List
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+
[detail level 123]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
\NFoam
 oCcfdemCloud
 oCglobal
 oCcfdemCloudIB
 oCaveragingModel
 oCdense
 oCdilute
 oCclockModel
 oCnoClock
 oCstandardClock
 oCdataExchangeModel
 oCnoDataExchange
 oConeWayVTK
 oCtwoWayFiles
 oCtwoWayMPI
 oCArchimedes
 oCArchimedesIB
 oCcheckCouplingInterval
 oCDiFeliceDrag
 oCfieldStore
 oCforceModel
 oCforceSubModel
 oCImEx
 oCGidaspowDrag
 oCgradPForce
 oCinterface
 oCKochHillDrag
 oCLaEuScalarTemp
 oCMeiLift
 oCnoDrag
 oCparticleCellVolume
 oCSchillerNaumannDrag
 oCShirgaonkarIB
 oCvirtualMassForce
 oCviscForce
 oCbasicIO
 oCIOModel
 oCnoIO
 oCsophIO
 oCtrackIO
 oCexecute
 oCliggghtsCommandModel
 oCreadLiggghtsData
 oCrunLiggghts
 oCwriteLiggghts
 oCengineSearch
 oCengineSearchIB
 oClocateModel
 oCstandardSearch
 oCmeshMotionModel
 oCnoMeshMotion
 oCexplicitCouple
 oCimplicitCouple
 oCmomCoupleModel
 oCnoCouple
 oCnoProbe
 oCparticleProbe
 oCprobeModel
 |\CfieldGroup
 oCallRegion
 oCregionModel
 oCconstDiffSmoothing
 oCnoSmoothing
 oCsmoothingModel
 oCbigParticleVoidFraction
 oCcentreVoidFraction
 oCdividedVoidFraction
 oCGaussVoidFraction
 oCIBVoidFraction
 \CvoidFractionModel
+
+
+ +
+Generated on Fri Sep 11 2015 15:26:21 for CFDEMcoupling by   +doxygen + 1.8.6 +
diff --git a/doc/doxygen/html/averagingModel_8H_source.html b/doc/doxygen/html/averagingModel_8H_source.html new file mode 100644 index 0000000..21461d8 --- /dev/null +++ b/doc/doxygen/html/averagingModel_8H_source.html @@ -0,0 +1,317 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/averagingModel/averagingModel/averagingModel.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
averagingModel.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31 Class
+
32  averagingModel
+
33 
+
34 SourceFiles
+
35  averagingModel.C
+
36 
+
37 \*---------------------------------------------------------------------------*/
+
38 
+
39 #ifndef averagingModel_H
+
40 #define averagingModel_H
+
41 
+
42 #include "fvCFD.H"
+
43 #include "cfdemCloud.H"
+
44 #include "dataExchangeModel.H"
+
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
46 
+
47 namespace Foam
+
48 {
+
49 
+
50 /*---------------------------------------------------------------------------*\
+
51  Class averagingModel Declaration
+
52 \*---------------------------------------------------------------------------*/
+
53 
+
54 class averagingModel
+
55 {
+
56 
+
57 protected:
+
58 
+
59  // Protected data
+
60  const dictionary& dict_;
+
61 
+
62  cfdemCloud& particleCloud_;
+
63 
+
64  mutable volScalarField UsWeightField_;
+
65 
+
66  mutable volVectorField UsPrev_;
+
67 
+
68  mutable volVectorField UsNext_;
+
69 
+
70  // Protected member functions
+
71 
+
72 public:
+
73 
+
74  //- Runtime type information
+
75  TypeName("averagingModel");
+
76 
+
77  // Declare runtime constructor selection table
+
78 
+
79  declareRunTimeSelectionTable
+
80  (
+
81  autoPtr,
+
82  averagingModel,
+
83  dictionary,
+
84  (
+
85  const dictionary& dict,
+
86  cfdemCloud& sm
+
87  ),
+
88  (dict,sm)
+
89  );
+
90 
+
91 
+
92  // Constructors
+
93 
+
94  //- Construct from components
+
95  averagingModel
+
96  (
+
97  const dictionary& dict,
+
98  cfdemCloud& sm
+
99  );
+
100 
+
101 
+
102  // Destructor
+
103 
+
104  virtual ~averagingModel();
+
105 
+
106 
+
107  // Selector
+
108 
+
109  static autoPtr<averagingModel> New
+
110  (
+
111  const dictionary& dict,
+
112  cfdemCloud& sm
+
113  );
+
114 
+
115 
+
116  // Member Function
+
117  virtual void setScalarAverage
+
118  (
+
119  volScalarField& field,
+
120  double**& value,
+
121  double**& weight,
+
122  volScalarField& weightField,
+
123  double**const& mask
+
124  ) const = 0;
+
125 
+
126  virtual void setVectorAverage
+
127  (
+
128  volVectorField& field,
+
129  double**& value,
+
130  double**& weight,
+
131  volScalarField& weightField,
+
132  double**const& mask
+
133  ) const = 0;
+
134 
+
135  void undoVectorAverage
+
136  (
+
137  volVectorField& fieldPrev,
+
138  volVectorField& fieldNext,
+
139  volScalarField& weightField,
+
140  double** const& value,
+
141  double** const& weight,
+
142  double**const& mask,
+
143  bool single=false
+
144  ) const;
+
145 
+
146  void undoVectorSum
+
147  (
+
148  volVectorField& field,
+
149  double** const& value,
+
150  double** const& weight,
+
151  double**const& mask
+
152  ) const;
+
153 
+
154 
+
155  void setVectorSum
+
156  (
+
157  volVectorField& field,
+
158  double**& value,
+
159  double**& weight,
+
160  double**const& mask
+
161  ) const;
+
162 
+
163  void setVectorSumSimple
+
164  (
+
165  volVectorField& field,
+
166  double**& value,
+
167  double**& weight,
+
168  int np
+
169  ) const;
+
170 
+
171  void setScalarSum
+
172  (
+
173  volScalarField& field,
+
174  double**& value,
+
175  double**const& weight,
+
176  double**const& mask
+
177  ) const;
+
178 
+
179  void setDSauter
+
180  (
+
181  volScalarField& dSauter,
+
182  double**& weight,
+
183  volScalarField& weightField,
+
184  label myParticleType = 0 // can be evaluated for a special type
+
185  ) const;
+
186 
+
187  void resetVectorAverage(volVectorField& prev,volVectorField& next,bool single=false) const;
+
188 
+
189  void resetWeightFields() const;
+
190 
+
191  void undoWeightFields(double**const&) const;
+
192 
+
193  tmp<volVectorField> UsInterp() const;
+
194 
+
195  virtual void setParticleType(label type) const {};
+
196 
+
197  virtual bool checkParticleType(label) const {return true;}; //consider all particles by default
+
198 
+
199  // Access
+
200  inline volVectorField& UsPrev() const {return UsPrev_;};
+
201 
+
202  inline volVectorField& UsNext() const {return UsNext_;};
+
203 
+
204  inline volScalarField& UsWeightField() const {return UsWeightField_;};
+
205 
+
206 };
+
207 
+
208 
+
209 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
210 
+
211 } // End namespace Foam
+
212 
+
213 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
214 
+
215 #endif
+
216 
+
217 // ************************************************************************* //
+
Foam::averagingModel
Definition: averagingModel.H:54
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/basicIO_8H_source.html b/doc/doxygen/html/basicIO_8H_source.html new file mode 100644 index 0000000..c3d8ee5 --- /dev/null +++ b/doc/doxygen/html/basicIO_8H_source.html @@ -0,0 +1,208 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/IOModel/basicIO/basicIO.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
basicIO.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31 Class
+
32  basicIO
+
33 
+
34 SourceFiles
+
35  basicIO.C
+
36 
+
37 \*---------------------------------------------------------------------------*/
+
38 
+
39 #ifndef basicIO_H
+
40 #define basicIO_H
+
41 
+
42 #include "IOModel.H"
+
43 #include "dataExchangeModel.H"
+
44 
+
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
46 
+
47 namespace Foam
+
48 {
+
49 
+
50 /*---------------------------------------------------------------------------*\
+
51  Class noDrag Declaration
+
52 \*---------------------------------------------------------------------------*/
+
53 
+
54 class basicIO
+
55 :
+
56  public IOModel
+
57 {
+
58 
+
59 private:
+
60 
+
61  //dictionary propsDict_;
+
62 
+
63  word dirName_;
+
64 
+
65  fileName path_;
+
66 
+
67  mutable int nPProc_;
+
68 
+
69  // Member Functions
+
70 
+
71 protected:
+
72  mutable fileName lagPath_;
+
73 
+
74 public:
+
75 
+
76  //- Runtime type information
+
77  TypeName("basicIO");
+
78 
+
79 
+
80  // Constructors
+
81 
+
82  //- Construct from components
+
83  basicIO
+
84  (
+
85  const dictionary& dict,
+
86  cfdemCloud& sm
+
87  );
+
88 
+
89  // Destructor
+
90 
+
91  ~basicIO();
+
92 
+
93 
+
94  // Member Functions
+
95  int dumpDEMdata() const;
+
96 };
+
97 
+
98 
+
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
100 
+
101 } // End namespace Foam
+
102 
+
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
104 
+
105 #endif
+
106 
+
107 // ************************************************************************* //
+
Foam::basicIO
Definition: basicIO.H:54
+
Foam::IOModel
Definition: IOModel.H:54
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/bc_s.png b/doc/doxygen/html/bc_s.png new file mode 100644 index 0000000..224b29a Binary files /dev/null and b/doc/doxygen/html/bc_s.png differ diff --git a/doc/doxygen/html/bdwn.png b/doc/doxygen/html/bdwn.png new file mode 100644 index 0000000..940a0b9 Binary files /dev/null and b/doc/doxygen/html/bdwn.png differ diff --git a/doc/doxygen/html/bigParticleVoidFraction_8H_source.html b/doc/doxygen/html/bigParticleVoidFraction_8H_source.html new file mode 100644 index 0000000..e3297c6 --- /dev/null +++ b/doc/doxygen/html/bigParticleVoidFraction_8H_source.html @@ -0,0 +1,210 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/voidFractionModel/bigParticleVoidFraction/bigParticleVoidFraction.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
bigParticleVoidFraction.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31 Class
+
32  bigParticleVoidFraction
+
33 
+
34 SourceFiles
+
35  bigParticleVoidFraction.C
+
36 
+
37 \*---------------------------------------------------------------------------*/
+
38 
+
39 #ifndef bigParticleVoidFraction_H
+
40 #define bigParticleVoidFraction_H
+
41 
+
42 #include "voidFractionModel.H"
+
43 
+
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
45 
+
46 namespace Foam
+
47 {
+
48 
+
49 /*---------------------------------------------------------------------------*\
+
50  Class noDrag Declaration
+
51 \*---------------------------------------------------------------------------*/
+
52 
+
53 class bigParticleVoidFraction
+
54 :
+
55  public voidFractionModel
+
56 {
+
57 
+
58 private:
+
59  dictionary propsDict_;
+
60 
+
61  const scalar alphaMin_; // min value of voidFraction
+
62 
+
63  mutable bool alphaLimited_;
+
64 
+
65 public:
+
66 
+
67  //- Runtime type information
+
68  TypeName("bigParticle");
+
69 
+
70 
+
71  // Constructors
+
72 
+
73  //- Construct from components
+
74  bigParticleVoidFraction
+
75  (
+
76  const dictionary& dict,
+
77  cfdemCloud& sm
+
78  );
+
79 
+
80  // Destructor
+
81 
+
82  ~bigParticleVoidFraction();
+
83 
+
84 
+
85  // Member Functions
+
86  void setvoidFraction(double** const& ,double**&, double**&, double**&, double**&) const;
+
87 
+
88  void buildLabelHashSet
+
89  (
+
90  const scalar radius,
+
91  const vector position,
+
92  const label cellID,
+
93  labelHashSet& hashSett
+
94  /*labelHashSet& hashSetComplete,
+
95  labelHashSet& hashSetPartial,
+
96  labelHashSet& hashSetRest*/
+
97  ) const;
+
98 };
+
99 
+
100 
+
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
102 
+
103 } // End namespace Foam
+
104 
+
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
106 
+
107 #endif
+
108 
+
109 // ************************************************************************* //
+
Foam::bigParticleVoidFraction
Definition: bigParticleVoidFraction.H:53
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::voidFractionModel
Definition: voidFractionModel.H:56
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/centreVoidFraction_8H_source.html b/doc/doxygen/html/centreVoidFraction_8H_source.html new file mode 100644 index 0000000..a25fb44 --- /dev/null +++ b/doc/doxygen/html/centreVoidFraction_8H_source.html @@ -0,0 +1,199 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/voidFractionModel/centreVoidFraction/centreVoidFraction.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
centreVoidFraction.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31 Class
+
32  centreVoidFraction
+
33 
+
34 SourceFiles
+
35  centreVoidFraction.C
+
36 
+
37 \*---------------------------------------------------------------------------*/
+
38 
+
39 #ifndef centreVoidFraction_H
+
40 #define centreVoidFraction_H
+
41 
+
42 #include "voidFractionModel.H"
+
43 
+
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
45 
+
46 namespace Foam
+
47 {
+
48 
+
49 /*---------------------------------------------------------------------------*\
+
50  Class noDrag Declaration
+
51 \*---------------------------------------------------------------------------*/
+
52 
+
53 class centreVoidFraction
+
54 :
+
55  public voidFractionModel
+
56 {
+
57 
+
58 private:
+
59  dictionary propsDict_;
+
60 
+
61  const scalar alphaMin_; //NP min value of voidFraction
+
62 
+
63  mutable bool alphaLimited_;
+
64 
+
65 public:
+
66 
+
67  //- Runtime type information
+
68  TypeName("centre");
+
69 
+
70 
+
71  // Constructors
+
72 
+
73  //- Construct from components
+
74  centreVoidFraction
+
75  (
+
76  const dictionary& dict,
+
77  cfdemCloud& sm
+
78  );
+
79 
+
80  // Destructor
+
81 
+
82  ~centreVoidFraction();
+
83 
+
84 
+
85  // Member Functions
+
86  void setvoidFraction(double** const& ,double**&, double**&, double**&, double**&) const;
+
87 };
+
88 
+
89 
+
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
91 
+
92 } // End namespace Foam
+
93 
+
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
95 
+
96 #endif
+
97 
+
98 // ************************************************************************* //
+
Foam::centreVoidFraction
Definition: centreVoidFraction.H:53
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::voidFractionModel
Definition: voidFractionModel.H:56
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/cfdemCloudIB_8H_source.html b/doc/doxygen/html/cfdemCloudIB_8H_source.html new file mode 100644 index 0000000..7254700 --- /dev/null +++ b/doc/doxygen/html/cfdemCloudIB_8H_source.html @@ -0,0 +1,211 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/derived/cfdemCloudIB/cfdemCloudIB.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
cfdemCloudIB.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  cloud class managing DEM data for CFD-DEM coupling and IB representation
+
32 
+
33 Class
+
34  Foam::cfdemCloudIB derived from cfdemCloud
+
35 
+
36 SourceFiles
+
37  cfdemCloudIB.C
+
38 
+
39 \*---------------------------------------------------------------------------*/
+
40 
+
41 #ifndef cfdemCloudIB_H
+
42 #define cfdemCloudIB_H
+
43 
+
44 #include "cfdemCloud.H"
+
45 
+
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
47 
+
48 namespace Foam
+
49 {
+
50 
+
51 /*---------------------------------------------------------------------------*\
+
52  Class cfdemCloudIB Declaration
+
53 \*---------------------------------------------------------------------------*/
+
54 
+
55 class cfdemCloudIB
+
56 :
+
57  public cfdemCloud
+
58 {
+
59 protected:
+
60 
+
61  mutable double **angularVelocities_;
+
62  label pRefCell_;
+
63  scalar pRefValue_;
+
64 
+
65  mutable bool haveEvolvedOnce_;
+
66  mutable bool skipLagrangeToEulerMapping_;
+
67 
+
68 public:
+
69 
+
70  // Constructors
+
71 
+
72  //- Construct from components
+
73  cfdemCloudIB
+
74  (
+
75  const fvMesh& mesh
+
76  );
+
77 
+
78  // Destructor
+
79 
+
80  ~cfdemCloudIB();
+
81 
+
82 
+
83  // Member Functions
+
84  void getDEMdata();
+
85 
+
86  bool reAllocArrays() const;
+
87 
+
88  bool evolve();
+
89 
+
90  void calcVelocityCorrection(volScalarField&,volVectorField&,volScalarField&,volScalarField&); // this could be moved to an IB mom couple model
+
91 
+
92  // Access
+
93  vector angularVelocity(int);
+
94 
+
95  inline double ** angularVelocities() const
+
96  {
+
97  return angularVelocities_;
+
98  };
+
99 
+
100 };
+
101 
+
102 
+
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
104 
+
105 } // End namespace Foam
+
106 
+
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
108 
+
109 #endif
+
110 
+
111 // ************************************************************************* //
+
Foam::cfdemCloudIB
Definition: cfdemCloudIB.H:55
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/cfdemCloudI_8H_source.html b/doc/doxygen/html/cfdemCloudI_8H_source.html new file mode 100644 index 0000000..d99c6c8 --- /dev/null +++ b/doc/doxygen/html/cfdemCloudI_8H_source.html @@ -0,0 +1,417 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloudI.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
cfdemCloudI.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31 \*---------------------------------------------------------------------------*/
+
32 
+
33 #include "momCoupleModel.H"
+
34 #include "smoothingModel.H"
+
35 #include "meshMotionModel.H"
+
36 #include "averagingModel.H"
+
37 #include "clockModel.H"
+
38 #include "IOModel.H"
+
39 #include "voidFractionModel.H"
+
40 #include "locateModel.H"
+
41 #include "probeModel.H"
+
42 
+
43 namespace Foam
+
44 {
+
45 
+
46 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
+
47 inline void cfdemCloud::setCG(double cg) const
+
48 {
+
49  cg_ = cg;
+
50  Info << "cg is set to: " << cg_ << endl;
+
51 };
+
52 
+
53 inline const bool& cfdemCloud::impDEMdrag() const
+
54 {
+
55  return impDEMdrag_;
+
56 };
+
57 
+
58 inline const bool& cfdemCloud::impDEMdragAcc() const
+
59 {
+
60  return impDEMdragAcc_;
+
61 };
+
62 
+
63 inline const scalar& cfdemCloud::imExSplitFactor() const
+
64 {
+
65  return imExSplitFactor_;
+
66 };
+
67 
+
68 inline const bool& cfdemCloud::treatVoidCellsAsExplicitForce() const
+
69 {
+
70  return treatVoidCellsAsExplicitForce_;
+
71 }
+
72 
+
73 inline const scalar& cfdemCloud::cg() const
+
74 {
+
75  return cg_;
+
76 };
+
77 
+
78 inline const bool& cfdemCloud::ignore() const
+
79 {
+
80  return ignore_;
+
81 }
+
82 
+
83 inline const fvMesh& cfdemCloud::mesh() const
+
84 {
+
85  return mesh_;
+
86 }
+
87 
+
88 inline bool cfdemCloud::solveFlow() const
+
89 {
+
90  return bool(solveFlow_);
+
91 }
+
92 
+
93 inline bool cfdemCloud::verbose() const
+
94 {
+
95  return verbose_;
+
96 }
+
97 
+
98 inline const IOdictionary& cfdemCloud::couplingProperties() const
+
99 {
+
100  return couplingProperties_;
+
101 }
+
102 
+
103 inline double ** cfdemCloud::positions() const
+
104 {
+
105  return positions_;
+
106 }
+
107 
+
108 inline double ** cfdemCloud::velocities() const
+
109 {
+
110  return velocities_;
+
111 }
+
112 
+
113 inline double ** cfdemCloud::fluidVels() const
+
114 {
+
115  return fluidVel_;
+
116 }
+
117 
+
118 inline double ** cfdemCloud::fAccs() const
+
119 {
+
120  return fAcc_;
+
121 }
+
122 
+
123 inline double ** cfdemCloud::impForces() const
+
124 {
+
125  return impForces_;
+
126 }
+
127 
+
128 inline double ** cfdemCloud::expForces() const
+
129 {
+
130  return expForces_;
+
131 }
+
132 
+
133 inline double ** cfdemCloud::DEMForces() const
+
134 {
+
135  return DEMForces_;
+
136 }
+
137 
+
138 inline double ** cfdemCloud::Cds() const
+
139 {
+
140  return Cds_;
+
141 }
+
142 
+
143 inline double ** cfdemCloud::radii() const
+
144 {
+
145  return radii_;
+
146 }
+
147 
+
148 inline double ** cfdemCloud::voidfractions() const
+
149 {
+
150  return voidfractions_;
+
151 }
+
152 
+
153 inline void cfdemCloud::get_radii(double **& values) const
+
154 {
+
155 // Info << "set_radii level=" << numberOfParticles_ << endl;
+
156  // make a copy of the array entries
+
157 // for (int i=0;i<numberOfParticles_;i++)
+
158 // radii_[0][i]=values[0][i];
+
159  values=radii_;
+
160 }
+
161 
+
162 inline double ** cfdemCloud::cellIDs() const
+
163 {
+
164  return cellIDs_;
+
165 }
+
166 
+
167 inline void cfdemCloud::get_cellIDs(double **& values) const
+
168 {
+
169 // // make a copy of the array entries
+
170 // for (int i=0;i<numberOfParticles_;i++)
+
171 // cellIDs_[0][i]=values[0][i];
+
172  values=cellIDs_;
+
173 }
+
174 
+
175 inline double ** cfdemCloud::particleWeights() const
+
176 {
+
177  return particleWeights_;
+
178 }
+
179 
+
180 inline label Foam::cfdemCloud::body(int index)
+
181 {
+
182  return index;
+
183 }
+
184 
+
185 inline double cfdemCloud::particleVolume(int index)
+
186 {
+
187  return particleV_[index][0];
+
188 }
+
189 
+
190 inline scalar cfdemCloud::radius(int index)
+
191 {
+
192  return radii_[index][0];
+
193 }
+
194 
+
195 inline double cfdemCloud::d(int index)
+
196 {
+
197  return 2*radii_[index][0];
+
198 }
+
199 
+
200 inline double cfdemCloud::d32(bool recalc)
+
201 {
+
202  if(d32_<0 || recalc)
+
203  {
+
204  scalar Ntot(0);
+
205  scalar Dtot(0);
+
206  scalar r(0);
+
207  for(int index = 0;index < numberOfParticles(); ++index)
+
208  {
+
209  r=radii_[index][0];
+
210  Ntot+=2*r*r*r;
+
211  Dtot+=r*r;
+
212  }
+
213  d32_=Ntot/Dtot;
+
214  }
+
215 
+
216  return d32_;
+
217 }
+
218 
+
219 inline int cfdemCloud::numberOfParticles() const
+
220 {
+
221  return numberOfParticles_;
+
222 }
+
223 
+
224 inline bool cfdemCloud::numberOfParticlesChanged() const
+
225 {
+
226  return numberOfParticlesChanged_;
+
227 }
+
228 
+
229 inline int cfdemCloud::numberOfClumps() const
+
230 {
+
231  Warning << "cfdemCloud::numberOfClumps() is not called correctly!" << endl;
+
232  return -1;
+
233 }
+
234 
+
235 inline bool cfdemCloud::arraysReallocated() const
+
236 {
+
237  return arraysReallocated_;
+
238 }
+
239 
+
240 inline const wordList& cfdemCloud::forceModels()
+
241 {
+
242  return forceModels_;
+
243 }
+
244 
+
245 inline const locateModel& cfdemCloud::locateM() const
+
246 {
+
247  return locateModel_;
+
248 }
+
249 
+
250 inline const momCoupleModel& cfdemCloud::momCoupleM(int i) const
+
251 {
+
252  return momCoupleModel_[i];
+
253 }
+
254 
+
255 inline const dataExchangeModel& cfdemCloud::dataExchangeM() const
+
256 {
+
257  return dataExchangeModel_;
+
258 }
+
259 
+
260 inline const IOModel& cfdemCloud::IOM() const
+
261 {
+
262  return IOModel_;
+
263 }
+
264 
+
265 inline const probeModel& cfdemCloud::probeM() const
+
266 {
+
267  return probeModel_;
+
268 }
+
269 
+
270 inline const voidFractionModel& cfdemCloud::voidFractionM() const
+
271 {
+
272  return voidFractionModel_;
+
273 }
+
274 
+
275 inline const averagingModel& cfdemCloud::averagingM() const
+
276 {
+
277  return averagingModel_;
+
278 }
+
279 
+
280 inline const clockModel& cfdemCloud::clockM() const
+
281 {
+
282  return clockModel_;
+
283 }
+
284 
+
285 inline const smoothingModel& cfdemCloud::smoothingM() const
+
286 {
+
287  return smoothingModel_;
+
288 }
+
289 
+
290 inline const meshMotionModel& cfdemCloud::meshMotionM() const
+
291 {
+
292  return meshMotionModel_;
+
293 }
+
294 
+
295 inline const wordList& cfdemCloud::liggghtsCommandModelList() const
+
296 {
+
297  return liggghtsCommandModelList_;
+
298 }
+
299 
+
300 inline autoPtr<liggghtsCommandModel>* cfdemCloud::liggghtsCommand() const
+
301 {
+
302  return liggghtsCommand_;
+
303 }
+
304 
+
305 #if defined(version21) || defined(version16ext)
+
306  #ifdef compre
+
307  inline const compressible::turbulenceModel& cfdemCloud::turbulence() const
+
308  #else
+
309  inline const incompressible::turbulenceModel& cfdemCloud::turbulence() const
+
310  #endif
+
311 #elif defined(version15)
+
312  inline const incompressible::RASModel& cfdemCloud::turbulence() const
+
313 #endif
+
314 {
+
315  return turbulence_;
+
316 }
+
317 
+
318 }
+
319 // ************************************************************************* //
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/cfdemCloud_8H_source.html b/doc/doxygen/html/cfdemCloud_8H_source.html new file mode 100644 index 0000000..596afac --- /dev/null +++ b/doc/doxygen/html/cfdemCloud_8H_source.html @@ -0,0 +1,533 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/cfdemCloud/cfdemCloud.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
cfdemCloud.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  cloud class managing DEM data for CFD-DEM coupling
+
32 
+
33 Class
+
34  Foam::cfdemCloud
+
35 
+
36 SourceFiles
+
37  cfdemCloud.C
+
38  cfdemCloudIO.C
+
39 
+
40 \*---------------------------------------------------------------------------*/
+
41 
+
42 #ifndef cfdemCloud_H
+
43 #define cfdemCloud_H
+
44 
+
45 // choose version
+
46 #include "OFversion.H"
+
47 #include <vector>
+
48 
+
49 #include "fvCFD.H"
+
50 #include "IFstream.H"
+
51 
+
52 #if defined(version21) || defined(version16ext)
+
53  #include "turbulenceModel.H"
+
54 #elif defined(version15)
+
55  #include "RASModel.H"
+
56 #endif
+
57 
+
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
59 
+
60 namespace Foam
+
61 {
+
62 
+
63 // forward declarations
+
64 class forceModel;
+
65 class locateModel;
+
66 class voidFractionModel;
+
67 class dataExchangeModel;
+
68 class IOModel;
+
69 class probeModel;
+
70 class averagingModel;
+
71 class clockModel;
+
72 class smoothingModel;
+
73 class momCoupleModel;
+
74 class meshMotionModel;
+
75 class liggghtsCommandModel;
+
76 
+
77 /*---------------------------------------------------------------------------*\
+
78  Class cfdemCloud Declaration
+
79 \*---------------------------------------------------------------------------*/
+
80 
+
81 class cfdemCloud
+
82 {
+
83 
+
84 // protected data
+
85 protected:
+
86  const fvMesh& mesh_;
+
87 
+
88  IOdictionary couplingProperties_;
+
89 
+
90  IOdictionary liggghtsCommandDict_;
+
91 
+
92  Switch solveFlow_;
+
93 
+
94  bool verbose_;
+
95 
+
96  bool ignore_;
+
97 
+
98  const word modelType_;
+
99 
+
100  mutable double **positions_;
+
101 
+
102  mutable double **velocities_;
+
103 
+
104  mutable double **fluidVel_;
+
105 
+
106  mutable double **fAcc_;
+
107 
+
108  mutable double **impForces_;
+
109 
+
110  mutable double **expForces_;
+
111 
+
112  mutable double **DEMForces_;
+
113 
+
114  mutable double **Cds_;
+
115 
+
116  mutable double **radii_;
+
117 
+
118  mutable double **voidfractions_;
+
119 
+
120  mutable double **cellIDs_;
+
121 
+
122  mutable double **particleWeights_;
+
123 
+
124  mutable double **particleVolumes_;
+
125 
+
126  mutable double **particleV_;
+
127 
+
128  int numberOfParticles_;
+
129 
+
130  scalar d32_;
+
131 
+
132  bool numberOfParticlesChanged_;
+
133 
+
134  mutable bool arraysReallocated_;
+
135 
+
136  const wordList forceModels_;
+
137 
+
138  const wordList momCoupleModels_;
+
139 
+
140  const wordList liggghtsCommandModelList_;
+
141 
+
142  const word turbulenceModelType_;
+
143 
+
144  mutable scalar cg_;
+
145 
+
146  bool cgOK_;
+
147 
+
148  bool impDEMdrag_;
+
149 
+
150  bool impDEMdragAcc_;
+
151 
+
152  mutable scalar imExSplitFactor_;
+
153 
+
154  mutable bool treatVoidCellsAsExplicitForce_; //will treat the coupling force in cells with no Us data explicitly
+
155 
+
156  bool useDDTvoidfraction_;
+
157 
+
158  mutable volScalarField ddtVoidfraction_;
+
159 
+
160  #if defined(version21) || defined(version16ext)
+
161  #ifdef compre
+
162  const compressible::turbulenceModel& turbulence_;
+
163  #else
+
164  const incompressible::turbulenceModel& turbulence_;
+
165  #endif
+
166  #elif defined(version15)
+
167  const incompressible::RASModel& turbulence_;
+
168  #endif
+
169 
+
170  autoPtr<forceModel>* forceModel_;
+
171 
+
172  autoPtr<locateModel> locateModel_;
+
173 
+
174  autoPtr<momCoupleModel>* momCoupleModel_;
+
175 
+
176  autoPtr<dataExchangeModel> dataExchangeModel_;
+
177 
+
178  autoPtr<IOModel> IOModel_;
+
179 
+
180  autoPtr<probeModel> probeModel_;
+
181 
+
182  autoPtr<voidFractionModel> voidFractionModel_;
+
183 
+
184  autoPtr<averagingModel> averagingModel_;
+
185 
+
186  autoPtr<clockModel> clockModel_;
+
187 
+
188  autoPtr<smoothingModel> smoothingModel_;
+
189 
+
190  autoPtr<meshMotionModel> meshMotionModel_;
+
191 
+
192  autoPtr<liggghtsCommandModel>* liggghtsCommand_;
+
193 
+
194 // Protected member functions
+
195  virtual void getDEMdata();
+
196 
+
197  virtual void giveDEMdata();
+
198 
+
199  virtual void setNumberOfParticles(int);
+
200 
+
201  virtual void findCells();
+
202 
+
203  virtual void setForces();
+
204 
+
205  virtual void setParticleForceField();
+
206 
+
207  virtual void setVectorAverages();
+
208 
+
209 public:
+
210 
+
211  friend class dataExchangeModel;
+
212  friend class voidFractionModel;
+
213  friend class forceModel;
+
214  friend class forceSubModel;
+
215 
+
216 // Constructors
+
217 
+
218  //- Construct from mesh and a list of particles
+
219  cfdemCloud
+
220  (
+
221  const fvMesh& mesh
+
222  );
+
223 
+
224  //- Destructor
+
225  virtual ~cfdemCloud();
+
226 
+
227 // public Member Functions
+
228 
+
229  // Access
+
230  void checkCG(bool);
+
231 
+
232  void setPos(double **&);
+
233 
+
234  word modelType(){ return modelType_; };
+
235 
+
236  label particleCell(int);
+
237 
+
238  vector position(int);
+
239 
+
240  vector velocity(int);
+
241 
+
242  vector fluidVel(int);
+
243 
+
244  virtual const forceModel& forceM(int);
+
245 
+
246  virtual int nrForceModels();
+
247 
+
248  scalar voidfraction(int);
+
249 
+
250  label liggghtsCommandModelIndex(word);
+
251 
+
252  inline void setCG(double) const;
+
253 
+
254  inline const scalar& cg() const;
+
255 
+
256  inline const bool& impDEMdrag() const;
+
257 
+
258  inline const bool& impDEMdragAcc() const;
+
259 
+
260  inline const scalar& imExSplitFactor() const;
+
261 
+
262  inline const bool& treatVoidCellsAsExplicitForce() const;
+
263 
+
264  inline const bool& ignore() const;
+
265 
+
266  inline const fvMesh& mesh() const;
+
267 
+
268  inline bool solveFlow() const;
+
269 
+
270  inline bool verbose() const;
+
271 
+
272  inline const IOdictionary& couplingProperties() const;
+
273 
+
274  inline double ** positions() const;
+
275 
+
276  inline double ** velocities() const;
+
277 
+
278  inline double ** fluidVels() const;
+
279 
+
280  inline double ** fAccs() const;
+
281 
+
282  inline double ** impForces() const;
+
283 
+
284  inline double ** expForces() const;
+
285 
+
286  inline double ** DEMForces() const;
+
287 
+
288  inline double ** Cds() const;
+
289 
+
290  inline double ** radii() const;
+
291 
+
292  inline double ** voidfractions() const;
+
293 
+
294  inline void get_radii(double**&) const;
+
295 
+
296  inline double ** cellIDs() const;
+
297 
+
298  inline void get_cellIDs(double**&) const;
+
299 
+
300  inline double ** particleWeights() const;
+
301 
+
302  virtual inline label body(int);
+
303 
+
304  virtual inline double particleVolume(int);
+
305 
+
306  inline scalar radius(int);
+
307 
+
308  virtual inline double d(int);
+
309 
+
310  inline scalar d32(bool recalc=true);
+
311  virtual inline double dMin() {return -1;}
+
312  virtual inline double dMax() {return -1;}
+
313  virtual inline int minType() {return -1;}
+
314  virtual inline int maxType() {return -1;}
+
315  virtual inline bool multipleTypesDMax() {return false;}
+
316  virtual inline bool multipleTypesDMin() {return false;}
+
317  virtual inline double ** particleDensity() const {return NULL;};
+
318  virtual inline int ** particleTypes() const {return NULL;};
+
319  virtual label particleType(label index) const {return -1;};
+
320 
+
321  //access to the particle's rotation and torque data
+
322  virtual inline double ** DEMTorques() const {return NULL;};
+
323  virtual inline double ** omegaArray() const {return NULL;};
+
324  virtual vector omega(int) const {return Foam::vector(0,0,0);};
+
325 
+
326  //access to the particles' orientation information
+
327  virtual inline double ** exArray() const {return NULL;};
+
328  virtual vector ex(int) const {return Foam::vector(0,0,0);};
+
329 
+
330  //Detector if SRF module is enable or not
+
331  virtual inline bool SRFOn(){return false;}
+
332 
+
333  inline int numberOfParticles() const;
+
334 
+
335  inline bool numberOfParticlesChanged() const;
+
336 
+
337  inline int numberOfClumps() const;
+
338 
+
339  inline bool arraysReallocated() const;
+
340 
+
341  inline const wordList& forceModels();
+
342 
+
343  inline const voidFractionModel& voidFractionM() const;
+
344 
+
345  inline const locateModel& locateM() const;
+
346 
+
347  inline const momCoupleModel& momCoupleM(int) const;
+
348 
+
349  inline const dataExchangeModel& dataExchangeM() const;
+
350 
+
351  inline const IOModel& IOM() const;
+
352 
+
353  inline const probeModel& probeM() const;
+
354 
+
355  inline const averagingModel& averagingM() const;
+
356 
+
357  inline const clockModel& clockM() const;
+
358 
+
359  inline const smoothingModel& smoothingM() const;
+
360 
+
361  inline const meshMotionModel& meshMotionM() const;
+
362 
+
363  inline const wordList& liggghtsCommandModelList() const;
+
364 
+
365  inline autoPtr<liggghtsCommandModel>* liggghtsCommand() const;
+
366 
+
367  #if defined(version21) || defined(version16ext)
+
368  #ifdef compre
+
369  inline const compressible::turbulenceModel& turbulence() const;
+
370  #else
+
371  inline const incompressible::turbulenceModel& turbulence() const;
+
372  #endif
+
373  #elif defined(version15)
+
374  inline const incompressible::RASModel& turbulence() const;
+
375  #endif
+
376 
+
377  // Write
+
378 
+
379  // write cfdemCloud internal data
+
380  virtual bool evolve(volScalarField&,volVectorField&,volVectorField&);
+
381 
+
382  virtual bool reAllocArrays() const;
+
383 
+
384  virtual bool reAllocArrays(int nP, bool forceRealloc) const; //force number of particles during reallocation
+
385 
+
386 
+
387  // IO
+
388  void writeScalarFieldToTerminal(double**&);
+
389 
+
390  void writeVectorFieldToTerminal(double**&);
+
391 
+
392  // functions
+
393  tmp<fvVectorMatrix> divVoidfractionTau(volVectorField& ,volScalarField&) const;
+
394 
+
395  tmp<volScalarField> ddtVoidfraction() const;
+
396 
+
397  void calcDdtVoidfraction(volScalarField& voidfraction) const;
+
398 
+
399  //tmp<fvVectorMatrix> ddtVoidfractionU(volVectorField& ,volScalarField&) const;
+
400 
+
401  tmp<volScalarField> voidfractionNuEff(volScalarField&) const;
+
402 
+
403  void resetArray(double**&,int,int,double resetVal=0.);
+
404 
+
405  std::vector< std::vector<double*> >* getVprobe();
+
406 
+
407  std::vector< std::vector<double> >* getSprobe();
+
408 
+
409 };
+
410 
+
411 
+
412 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
413 
+
414 } // End namespace Foam
+
415 
+
416 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
417 
+
418 #include "cfdemCloudI.H"
+
419 
+
420 #endif
+
421 
+
422 // ************************************************************************* //
+
Foam::averagingModel
Definition: averagingModel.H:54
+
Foam::meshMotionModel
Definition: meshMotionModel.H:53
+
Foam::dataExchangeModel
Definition: dataExchangeModel.H:53
+
Foam::IOModel
Definition: IOModel.H:54
+
Foam::momCoupleModel
Definition: momCoupleModel.H:54
+
Foam::clockModel
Definition: clockModel.H:58
+
Foam::forceSubModel
Definition: forceSubModel.H:54
+
Foam::smoothingModel
Definition: smoothingModel.H:54
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::voidFractionModel
Definition: voidFractionModel.H:56
+
Foam::forceModel
Definition: forceModel.H:55
+
Foam::probeModel
Definition: probeModel.H:54
+
Foam::locateModel
Definition: locateModel.H:53
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/checkCouplingInterval_8H_source.html b/doc/doxygen/html/checkCouplingInterval_8H_source.html new file mode 100644 index 0000000..c643c57 --- /dev/null +++ b/doc/doxygen/html/checkCouplingInterval_8H_source.html @@ -0,0 +1,201 @@ + + + + + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/subModels/forceModel/checkCouplingInterval/checkCouplingInterval.H Source File + + + + + + + + + +
+
+ + + + + + +
+
CFDEMcoupling +  2.4 +
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
checkCouplingInterval.H
+
+
+
1 /*---------------------------------------------------------------------------*\
+
2  CFDEMcoupling - Open Source CFD-DEM coupling
+
3 
+
4  CFDEMcoupling is part of the CFDEMproject
+
5  www.cfdem.com
+
6  Christoph Goniva, christoph.goniva@cfdem.com
+
7  Copyright 2009-2012 JKU Linz
+
8  Copyright 2012- DCS Computing GmbH, Linz
+
9 -------------------------------------------------------------------------------
+
10 License
+
11  This file is part of CFDEMcoupling.
+
12 
+
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
+
14  under the terms of the GNU General Public License as published by the
+
15  Free Software Foundation; either version 3 of the License, or (at your
+
16  option) any later version.
+
17 
+
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+
21  for more details.
+
22 
+
23  You should have received a copy of the GNU General Public License
+
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
+
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
26 
+
27 Description
+
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
+
30 
+
31  check the coupling interval,
+
32  by comparing couplingTime/particle relaxation time
+
33 
+
34 Class
+
35  checkCouplingInterval
+
36 
+
37 SourceFiles
+
38  checkCouplingInterval.C
+
39 
+
40 \*---------------------------------------------------------------------------*/
+
41 
+
42 #ifndef checkCouplingInterval_H
+
43 #define checkCouplingInterval_H
+
44 
+
45 #include "forceModel.H"
+
46 #include "dataExchangeModel.H"
+
47 #include "mpi.h"
+
48 
+
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
50 
+
51 namespace Foam
+
52 {
+
53 
+
54 /*---------------------------------------------------------------------------*\
+
55  Class checkCouplingInterval Declaration
+
56 \*---------------------------------------------------------------------------*/
+
57 
+
58 class checkCouplingInterval
+
59 :
+
60  public forceModel
+
61 {
+
62 private:
+
63  dictionary propsDict_;
+
64 
+
65  const scalar rhoP_;
+
66 
+
67 public:
+
68 
+
69  //- Runtime type information
+
70  TypeName("checkCouplingInterval");
+
71 
+
72 
+
73  // Constructors
+
74 
+
75  //- Construct from components
+
76  checkCouplingInterval
+
77  (
+
78  const dictionary& dict,
+
79  cfdemCloud& sm
+
80  );
+
81 
+
82  // Destructor
+
83 
+
84  ~checkCouplingInterval();
+
85 
+
86 
+
87  // Member Functions
+
88  void setForce() const;
+
89 };
+
90 
+
91 
+
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
93 
+
94 } // End namespace Foam
+
95 
+
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
97 
+
98 #endif
+
99 
+
100 // ************************************************************************* //
+
Foam::checkCouplingInterval
Definition: checkCouplingInterval.H:58
+
Foam::cfdemCloud
Definition: cfdemCloud.H:81
+
Foam::forceModel
Definition: forceModel.H:55
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
+ + diff --git a/doc/doxygen/html/checkModelType_8H_source.html b/doc/doxygen/html/checkModelType_8H_source.html index e70936b..a101437 100644 --- a/doc/doxygen/html/checkModelType_8H_source.html +++ b/doc/doxygen/html/checkModelType_8H_source.html @@ -1,127 +1,199 @@ - -CFDEMcoupling: /home/cfdem/CFDEM/CFDEM-x.x-2.0.x/src/lagrangian/cfdemParticle/cfdTools/checkModelType.H Source File + + +CFDEMcoupling: /home/cgoniva/CFDEM/CFDEM-x.x-2.1.x/CFDEMcoupling-PUBLIC/src/lagrangian/cfdemParticle/cfdTools/checkModelType.H Source File + + - - + + + - - - - +
+
+
checkModelType.H
+
+
+
1 
+
2  // check model type
+
3  // referring to: Zhou et al. 2010,JFM
+
4  word modelType = particleCloud.modelType();
+
5 
+
6  //Warning << "model type not being checked" << endl;
+
7  if (modelType=="Bfull"){
+
8  Info << "solving volume averaged Navier Stokes equations of type B\n"<< endl;
+
9 
+
10  // check if Archimedes is used
+
11  bool found=false;
+
12  forAll(particleCloud.forceModels(),i)
+
13  {
+
14  if(particleCloud.forceModels()[i]=="Archimedes")
+
15  found=true;
+
16  }
+
17  if(!found)
+
18  FatalError <<"Archimedes model not found!\n" << abort(FatalError);
+
19 
+
20  // check if gradPForce is used
+
21  found=false;
+
22  forAll(particleCloud.forceModels(),i)
+
23  {
+
24  if(particleCloud.forceModels()[i]=="gradPForce")
+
25  found=true;
+
26  }
+
27  if(!found)
+
28  FatalError <<"gradPForce model not found!\n" << abort(FatalError);
+
29 
+
30  // check if viscForce is used
+
31  found=false;
+
32  forAll(particleCloud.forceModels(),i)
+
33  {
+
34  if(particleCloud.forceModels()[i]=="viscForce")
+
35  found=true;
+
36  }
+
37  if(!found)
+
38  FatalError <<"viscForce model not found!\n" << abort(FatalError);
+
39 
+
40  }else if(modelType=="B"){
+
41  Info << "solving volume averaged Navier Stokes equations of type B\n"<< endl;
+
42 
+
43  // check if Archimedes is used
+
44  bool found=false;
+
45  forAll(particleCloud.forceModels(),i)
+
46  {
+
47  if(particleCloud.forceModels()[i]=="Archimedes")
+
48  found=true;
+
49  }
+
50  if(!found)
+
51  FatalError <<"Archimedes model not found!\n" << abort(FatalError);
+
52 
+
53 
+
54 
+
55  // check if gradP and viscForce are used
+
56  found=false;
+
57  forAll(particleCloud.forceModels(),i)
+
58  {
+
59  if(particleCloud.forceModels()[i]=="gradPForce" || particleCloud.forceModels()[i]=="viscForce")
+
60  found=true;
+
61  }
+
62  if(found)
+
63  FatalError <<"do not use gradPForce and viscForce with model type B!\n" << abort(FatalError);
+
64 
+
65  }else if (modelType=="A"){
+
66  Info << "solving volume averaged Navier Stokes equations of type A\n"
+
67  << "check if Archimedes lift is necessary (depends on pressure formulation)\n"<< endl;
+
68 
+
69  // check if Archimedes is used
+
70  bool found=false;
+
71  forAll(particleCloud.forceModels(),i)
+
72  {
+
73  if(particleCloud.forceModels()[i]=="Archimedes")
+
74  found=true;
+
75  }
+
76  if(found)
+
77  Info << "WARNING!!! Are you sure to use Archimedes lift, not necessary if gradPForce includes this effect." << endl;
+
78 
+
79  // check if gradP is used
+
80  found=false;
+
81  forAll(particleCloud.forceModels(),i)
+
82  {
+
83  if(particleCloud.forceModels()[i]=="gradPForce")
+
84  found=true;
+
85  }
+
86  if(!found)
+
87  FatalError <<"gradPForce model not found!\n" << abort(FatalError);
+
88 
+
89  // check if viscForce is used
+
90  found=false;
+
91  forAll(particleCloud.forceModels(),i)
+
92  {
+
93  if(particleCloud.forceModels()[i]=="viscForce")
+
94  found=true;
+
95  }
+
96  if(!found)
+
97  FatalError <<"viscForce model not found!\n" << abort(FatalError);
+
98  }else if (modelType=="none")
+
99  Warning << "You chose model type -none- you might get erroneous results!" << endl;
+
100  else
+
101  FatalError <<"no suitable model type specified:" << modelType << "\n" << abort(FatalError);
+
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
diff --git a/doc/doxygen/html/classFoam_1_1Archimedes-members.html b/doc/doxygen/html/classFoam_1_1Archimedes-members.html index 7b2a08e..e0b4324 100644 --- a/doc/doxygen/html/classFoam_1_1Archimedes-members.html +++ b/doc/doxygen/html/classFoam_1_1Archimedes-members.html @@ -1,101 +1,138 @@ - + + CFDEMcoupling: Member List + + - - + + + - - - - +
+
+
Foam::Archimedes Member List
+
+
+ +

This is the complete list of members for Foam::Archimedes, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Archimedes(const dictionary &dict, cfdemCloud &sm) (defined in Foam::Archimedes)Foam::Archimedes
Cds() const (defined in Foam::forceModel)Foam::forceModelinline
coupleForce() const (defined in Foam::forceModel)Foam::forceModelinline
coupleForce_ (defined in Foam::forceModel)Foam::forceModelprotected
declareRunTimeSelectionTable(autoPtr, forceModel, dictionary,(const dictionary &dict, cfdemCloud &sm),(dict, sm)) (defined in Foam::forceModel)Foam::forceModel
DEMForces() const (defined in Foam::forceModel)Foam::forceModelinline
dict_ (defined in Foam::forceModel)Foam::forceModelprotected
expForces() const (defined in Foam::forceModel)Foam::forceModelinline
expParticleForces() const (defined in Foam::forceModel)Foam::forceModelinline
expParticleForces_ (defined in Foam::forceModel)Foam::forceModelmutableprotected
fluidVel() const (defined in Foam::forceModel)Foam::forceModelinline
forceModel(const dictionary &dict, cfdemCloud &sm) (defined in Foam::forceModel)Foam::forceModel
forceSubM(int i) const (defined in Foam::forceModel)Foam::forceModelinline
forceSubModel_ (defined in Foam::forceModel)Foam::forceModelprotected
forceSubModels() (defined in Foam::forceModel)Foam::forceModelinline
forceSubModels_ (defined in Foam::forceModel)Foam::forceModelprotected
impForces() const (defined in Foam::forceModel)Foam::forceModelinline
impParticleForces() const (defined in Foam::forceModel)Foam::forceModelinline
impParticleForces_ (defined in Foam::forceModel)Foam::forceModelmutableprotected
manipulateScalarField(volScalarField &) const (defined in Foam::forceModel)Foam::forceModelvirtual
modelType() (defined in Foam::forceModel)Foam::forceModelinline
modelType_ (defined in Foam::forceModel)Foam::forceModelprotected
New(const dictionary &dict, cfdemCloud &sm, word forceType) (defined in Foam::forceModel)Foam::forceModelstatic
nrForceSubModels() (defined in Foam::forceModel)Foam::forceModelinline
particleCloud_ (defined in Foam::forceModel)Foam::forceModelprotected
probeIt_ (defined in Foam::forceModel)Foam::forceModelprotected
repartitionImExForces() const (defined in Foam::forceModel)Foam::forceModel
requiresEx() (defined in Foam::forceModel)Foam::forceModelinlinevirtual
requiresEx_ (defined in Foam::forceModel)Foam::forceModelprotected
setForce() const (defined in Foam::Archimedes)Foam::Archimedesvirtual
setForceSubModels(dictionary &dict) (defined in Foam::forceModel)Foam::forceModel
treatVoidCells() const (defined in Foam::forceModel)Foam::forceModel
TypeName("Archimedes") (defined in Foam::Archimedes)Foam::Archimedes
TypeName("forceModel") (defined in Foam::forceModel)Foam::forceModel
~Archimedes() (defined in Foam::Archimedes)Foam::Archimedes
~forceModel() (defined in Foam::forceModel)Foam::forceModelvirtual
+ +
+Generated on Fri Sep 11 2015 15:26:20 for CFDEMcoupling by   +doxygen + 1.8.6 +
diff --git a/doc/doxygen/html/classFoam_1_1Archimedes.html b/doc/doxygen/html/classFoam_1_1Archimedes.html index 8291343..6b74645 100644 --- a/doc/doxygen/html/classFoam_1_1Archimedes.html +++ b/doc/doxygen/html/classFoam_1_1Archimedes.html @@ -1,104 +1,232 @@ - + + CFDEMcoupling: Foam::Archimedes Class Reference + + - - + + + - - - -