Renamed folder -> directory for consistency with POSIX and the rest of OpenFOAM

This commit is contained in:
Henry 2014-01-30 13:01:04 +00:00
parent c080ca7e86
commit ee4e19ef85
59 changed files with 95 additions and 86 deletions

6
.gitignore vendored
View File

@ -31,10 +31,10 @@ core
# dependency files - anywhere
*.dep
# lnInclude (symlink) folders - anywhere
# lnInclude (symlink) directories - anywhere
lnInclude
# build folders - anywhere
# build directories - anywhere
linux*Clang*/
linux*Gcc*/
linux*Icc*/
@ -44,7 +44,7 @@ solaris*Gcc*/
SunOS*Gcc*/
platforms/
# reinstate wmake/rules that might look like build folders
# reinstate wmake/rules that might look like build directories
!wmake/rules/*/
# doxygen generated documentation

View File

@ -748,7 +748,7 @@ int main(int argc, char *argv[])
subsetter.faceMap()
)();
// Read all fields in time and constant folders
// Read all fields in time and constant directories
IOobjectList objects(mesh, runTime.timeName());
IOobjectList timeObjects(IOobjectList(mesh, mesh.facesInstance()));
forAllConstIter(IOobjectList, timeObjects, iter)

View File

@ -44,7 +44,7 @@ void writeWeights
(
const scalarField& wghtSum,
const primitivePatch& patch,
const fileName& folder,
const fileName& directory,
const fileName& prefix,
const word& timeName
)
@ -53,7 +53,7 @@ void writeWeights
writer.write
(
folder,
directory,
prefix + "_proc" + Foam::name(Pstream::myProcNo()) + "_" + timeName,
patch.localPoints(),
patch.localFaces(),

View File

@ -134,12 +134,12 @@ void Foam::helpType::displayDoc
// can use FOAM_DOC_BROWSER='application file://%f' if required
docBrowser.replaceAll("%f", docFile);
fileName classFolder(parser.subDict(className).lookup("path"));
fileName classDirectory(parser.subDict(className).lookup("path"));
word classFile(parser.subDict(className).lookup("name"));
Info<< "Showing documentation for type " << className << nl << endl;
Info<< "Source file: " << classFolder.c_str() << classFile << nl
Info<< "Source file: " << classDirectory.c_str() << classFile << nl
<< endl;
system(docBrowser);

View File

@ -177,7 +177,7 @@ int main(int argc, char *argv[])
volTensorField::typeName
};
// Path to EnSight folder at case level only
// Path to EnSight directory at case level only
// - For parallel cases, data only written from master
fileName ensightDir = args.rootPath()/args.globalCaseName()/"EnSight";

View File

@ -28,7 +28,7 @@ ADD_DEFINITIONS(
-DWM_$ENV{WM_PRECISION_OPTION}
)
# Set output library destination to plugin folder
# Set output library destination to plugin directory
SET(
LIBRARY_OUTPUT_PATH $ENV{PV_PLUGIN_PATH}
CACHE INTERNAL

View File

@ -28,7 +28,7 @@ ADD_DEFINITIONS(
-DWM_$ENV{WM_PRECISION_OPTION}
)
# Set output library destination to plugin folder
# Set output library destination to plugin directory
SET(
LIBRARY_OUTPUT_PATH $ENV{PV_PLUGIN_PATH}
CACHE INTERNAL

View File

@ -28,7 +28,7 @@ ADD_DEFINITIONS(
-DWM_$ENV{WM_PRECISION_OPTION}
)
# Set output library destination to plugin folder
# Set output library destination to plugin directory
SET(
LIBRARY_OUTPUT_PATH $ENV{PV_PLUGIN_PATH}
CACHE INTERNAL

View File

@ -28,7 +28,7 @@ ADD_DEFINITIONS(
-DWM_$ENV{WM_PRECISION_OPTION}
)
# Set output library destination to plugin folder
# Set output library destination to plugin directory
SET(
LIBRARY_OUTPUT_PATH $ENV{PV_PLUGIN_PATH}
CACHE INTERNAL

View File

@ -27,7 +27,7 @@ Application
Description
Execute the set of functionObjects specified in the selected dictionary
(which defaults to system/controlDict) for the selected set of times.
Alternative dictionaries should be placed in the system/ folder.
Alternative dictionaries should be placed in the system/ directory.
The flow (p-U) and optionally turbulence fields are available for the
function objects to operate on allowing forces and other related properties

View File

@ -35,7 +35,7 @@ Description
On execution, the field <fieldName> is read, and its boundary conditions
interrogated for the presence of an \c externalCoupled type. If found,
the patch geometry (points and faces) for the coupled patches are output
to the communications folder.
to the communications directory.
Note:
The addressing is patch-local, i.e. point indices for each patch point

View File

@ -2,6 +2,6 @@ boundaryInfo.C
boundaryTemplates.C
caseInfo.C
solverTemplate.C
createZeroFolder.C
createZeroDirectory.C
EXE = $(FOAM_APPBIN)/createZeroFolder
EXE = $(FOAM_APPBIN)/createZeroDirectory

View File

@ -562,14 +562,14 @@ SHOW_DIRECTORIES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.
# Directory Tree View (if specified). The default is YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page.
# This will remove the Namespaces entry from the Quick Index
# and from the Folder Tree View (if specified). The default is YES.
# and from the Directory Tree View (if specified). The default is YES.
SHOW_NAMESPACES = YES
@ -1080,7 +1080,7 @@ GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
# The path specified is relative to the HTML output folder.
# The path specified is relative to the HTML output directory.
QCH_FILE =
@ -1092,7 +1092,7 @@ QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
# http://doc.trolltech.com/qthelpproject.html#virtual-directories
QHP_VIRTUAL_FOLDER = doc

View File

@ -114,7 +114,7 @@ protected:
public:
//- Folder prefix
//- Directory prefix
static const word outputPrefix;
//- Additional characters for writing

View File

@ -31,7 +31,7 @@ Description
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions. As input, the user specifies a look-up table
of U+ as a function of near-wall Reynolds number. The table should be
located in the $FOAM_CASE/constant folder.
located in the $FOAM_CASE/constant directory.
\heading Patch usage

View File

@ -48,7 +48,7 @@ Description
...
<valueN> <gradientN> <valueFracionN>
Data is sent/received as a single file for all patches from the folder
Data is sent/received as a single file for all patches from the directory
$FOAM_CASE/<commsDir>
@ -75,7 +75,7 @@ Description
\table
Property | Description | Required | Default value
commsDir | communications folder | yes |
commsDir | communications directory | yes |
fileName | transfer file name | yes |
waitInterval | interval [s] between file checks | no | 1
timeOut | time after which error invoked [s] |no |100*waitInterval
@ -135,7 +135,7 @@ private:
typedef externalCoupledMixedFvPatchField<Type> patchType;
typedef GeometricField<Type, fvPatchField, volMesh> volFieldType;
//- Path to communications folder
//- Path to communications directory
fileName commsDir_;
//- Name of data file
@ -178,7 +178,7 @@ private:
//- Set the master flag when collate option is selected
void setMaster(const labelList& patchIDs);
//- Return the file path to the base communications folder
//- Return the file path to the base communications directory
fileName baseDir() const;
//- Write the geometry to the comms dir

View File

@ -38,7 +38,7 @@ defineTypeNameAndDebug(writeDictionary, 0);
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
bool Foam::writeDictionary::tryFolder
bool Foam::writeDictionary::tryDirectory
(
const label dictI,
const word& location,
@ -167,16 +167,16 @@ void Foam::writeDictionary::execute()
}
else
{
bool processed = tryFolder(i, obr_.time().timeName(), firstDict);
bool processed = tryDirectory(i, obr_.time().timeName(), firstDict);
if (!processed)
{
processed = tryFolder(i, obr_.time().constant(), firstDict);
processed = tryDirectory(i, obr_.time().constant(), firstDict);
}
if (!processed)
{
processed = tryFolder(i, obr_.time().system(), firstDict);
processed = tryDirectory(i, obr_.time().system(), firstDict);
}
if (!processed)

View File

@ -80,7 +80,7 @@ protected:
// Private Member Functions
//- Helper function to write the dictionary if found at location
bool tryFolder
bool tryDirectory
(
const label dictI,
const word& location,

View File

@ -84,7 +84,7 @@ Where:
\endtable
The sub-dictionary name \c myFunctionObject is chosen by the user, and is
typically used as the name of the output folder for any derived data. The
typically used as the name of the output directory for any derived data. The
\c type entry defines the type of function object properties that follow.
Since the function objects are packaged into separate libraries, the user must
tell the code where to find the function object implementation, identified

View File

@ -28,7 +28,7 @@ Group
grpFieldFunctionObjects
Description
This function object reads fields from the time folders and adds them to
This function object reads fields from the time directories and adds them to
the mesh database for further post-processing.
Example of function object specification:

View File

@ -29,7 +29,7 @@ Group
Description
This function object evaluates and outputs the shear stress at wall
patches. The result is written as a volVectorField to time folders as
patches. The result is written as a volVectorField to time directories as
field 'wallShearStress'
\f[

View File

@ -29,7 +29,7 @@ Group
Description
Evaluates and outputs turbulence y+ for LES models. Values written to
time folders as field 'yPlusLES'
time directories as field 'yPlusLES'
SourceFiles
yPlusLES.C

View File

@ -29,7 +29,7 @@ Group
Description
Evaluates and outputs turbulence y+ for RAS models. Values written to
time folders as field 'yPlusRAS'
time directories as field 'yPlusRAS'
SourceFiles
yPlusRAS.C

View File

@ -112,7 +112,9 @@ Foam::sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
{
pointPatchDist pDist(pointMesh::New(mesh), patchSet_, points0());
const pointMesh& pMesh = pointMesh::New(mesh);
pointPatchDist pDist(pMesh, patchSet_, points0());
// Scaling: 1 up to di then linear down to 0 at do away from patches
scale_.internalField() =
@ -141,7 +143,7 @@ Foam::sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver
scalar(1)
);
scale_.correctBoundaryConditions();
pointConstraints::New(pMesh).constrain(scale_);
scale_.write();
}
}

View File

@ -48,7 +48,7 @@ Description
...
<valueN> <gradientN> <valueFracionN>
Data is sent/received as a single file for all patches from the folder
Data is sent/received as a single file for all patches from the directory
$FOAM_CASE/<commsDir>
@ -75,7 +75,7 @@ Description
\table
Property | Description | Required | Default value
commsDir | communications folder | yes |
commsDir | communications directory | yes |
fileName | transfer file name | yes |
waitInterval | interval [s] between file checks | no | 1
timeOut | time after which error invoked [s] |no |100*waitInterval

View File

@ -31,7 +31,7 @@ Description
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions. As input, the user specifies a look-up table
of U+ as a function of near-wall Reynolds number. The table should be
located in the $FOAM_CASE/constant folder.
located in the $FOAM_CASE/constant directory.
\heading Patch usage

View File

@ -39,7 +39,7 @@ usage()
usage: ${0##*/} [OPTION]
options:
-root <dir> specify root folder to run tests from
-root <dir> specify root directory to run tests from
-default sets up a default scheme on all schemes
-help print the usage

View File

@ -5,7 +5,7 @@ h2 : H2 combustion, 10 species, 27 reactions
nc7h16 : n-Heptane combustion, 544 species, 2446 reactions
ic8h18 : iso-Octane combustion, 874 species, 3796 reactions
Results interpreted in 'validation' sub-folder, where OpenFOAM results
Results interpreted in 'validation' sub-directory, where OpenFOAM results
are compared against those predicted by CHEMKIN II.
Overall the best performing ODE solver is seulex followed closely by rodas23.

View File

@ -87,7 +87,7 @@ SETSDIR="../postProcessing/sets"
if [ ! -d $SETSDIR ]
then
echo "createGraphs: results sets not available in folder $SETSDIR"
echo "createGraphs: results sets not available in directory $SETSDIR"
exit 0
fi

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions
# copy propeller surface from resources folder
# copy propeller surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/propellerTip.obj.gz constant/triSurface/

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions
# copy motorbike surface from resources folder
# copy motorbike surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/motorBike.obj.gz constant/triSurface/
# Make dummy 0 directory

View File

@ -1,4 +1,4 @@
Folder to house tri-surfaces
Directory to house tri-surfaces
The Allrun script copies the surface from the $FOAM_TUTORIALS/resources/geometry
folder
directory

View File

@ -1,7 +1,7 @@
#!/bin/sh
cd ${0%/*} || exit 1 # run from this directory
# Clean time folders only
# Clean time directories only
rm -rf *[1-9]*
rm -f log.* 2>/dev/null

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions
# copy motorbike surface from resources folder
# copy motorbike surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/motorBike.obj.gz constant/triSurface/
runApplication surfaceFeatureExtract

View File

@ -1,4 +1,4 @@
Folder to house tri-surfaces
Directory to house tri-surfaces
The Allrun script copies the surface from the $FOAM_TUTORIALS/resources/geometry
folder
directory

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial clean functions
. $WM_PROJECT_DIR/bin/tools/CleanFunctions
# remove old time and post-processing folders
# remove old time and post-processing directories
rm -rf 0 *[1-9]* processor* postProcessing

View File

@ -1,4 +1,4 @@
Folder to house tri-surfaces
Directory to house tri-surfaces
The Allrun script copies the surface from the $FOAM_TUTORIALS/resources/geometry
folder
directory

View File

@ -9,7 +9,7 @@ cleanCase
# remove 0 directory
rm -rf 0
# remove post-processing folder
# remove post-processing directory
rm -rf postProcessing
# copy 0.org to 0

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial clean functions
. $WM_PROJECT_DIR/bin/tools/CleanFunctions
# remove old time and post-processing folders
# remove old time and post-processing directories
rm -rf 0 *[1-9]* processor* postProcessing
cleanCase

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial clean functions
. $WM_PROJECT_DIR/bin/tools/CleanFunctions
# remove old time and post-processing folders
# remove old time and post-processing directories
rm -rf 0 *[1-9]* processor* postProcessing
# copy 0.org to 0

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions
# copy flange surface from resources folder
# copy flange surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/blob.stl.gz constant/triSurface/
runApplication foamyHexMesh

View File

@ -7,7 +7,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Get the number of processors to run on from system/decomposeParDict
nProc=$(getNumberOfProcessors)
# copy flange surface from resources folder
# copy flange surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/blob.stl.gz constant/triSurface/
runApplication blockMesh -region backgroundMeshDecomposition

View File

@ -1,4 +1,4 @@
Folder to house tri-surfaces
Directory to house tri-surfaces
The Allrun script copies the surface from the $FOAM_TUTORIALS/resources/geometry
folder
directory

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions
# copy flange surface from resources folder
# copy flange surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/flange.stl.gz constant/triSurface/
runApplication foamyHexMesh

View File

@ -7,7 +7,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Get the number of processors to run on from system/decomposeParDict
nProc=$(getNumberOfProcessors)
# copy flange surface from resources folder
# copy flange surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/flange.stl.gz constant/triSurface/
# Create tight-fitting background mesh

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions
# copy flange surface from resources folder
# copy flange surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/flange.stl.gz constant/triSurface/
cp system/controlDict system/controlDict.org

View File

@ -1,4 +1,4 @@
Folder to house tri-surfaces
Directory to house tri-surfaces
The Allrun script copies the surface from the $FOAM_TUTORIALS/resources/geometry
folder
directory

View File

@ -2,7 +2,7 @@
# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions
# copy flange surface from resources folder
# copy flange surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/flange.stl.gz constant/triSurface/
runApplication blockMesh

View File

@ -1,4 +1,4 @@
Folder to house tri-surfaces
Directory to house tri-surfaces
The Allrun script copies the surface from the $FOAM_TUTORIALS/resources/geometry
folder
directory

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions
# copy wigley surface from resources folder
# copy wigley surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/wigley-scaled-oriented.stl.gz constant/triSurface/
runApplication blockMesh

View File

@ -1,4 +1,4 @@
Folder to house tri-surfaces
Directory to house tri-surfaces
The Allrun script copies the surface from the $FOAM_TUTORIALS/resources/geometry
folder
directory

View File

@ -38,7 +38,7 @@ boundaryField
outlet
{
type inletOutlet;
type pressureInletOutletVelocity;
inletValue uniform (0 0 0);
value uniform (0 0 0);
}

View File

@ -31,7 +31,13 @@ boundaryField
outlet
{
type fixedValue;
type totalPressure;
p0 $internalField;
U U;
phi phi;
rho rho;
psi none;
gamma 1;
value $internalField;
}

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions
# copy propeller surface from resources folder
# copy propeller surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/propellerTip.obj.gz constant/triSurface/

View File

@ -23,7 +23,7 @@ libs
application interPhaseChangeDyMFoam;
startFrom latestTime;
startFrom startTime;
startTime 0;
@ -54,6 +54,6 @@ runTimeModifiable true;
adjustTimeStep yes;
maxCo 2;
maxAlphaCo 2;
maxAlphaCo 1;
// ************************************************************************* //

View File

@ -30,6 +30,7 @@ solvers
tolerance 1e-8;
relTol 0;
maxIter 10;
minIter 1;
};
"pcorr.*"
@ -65,12 +66,12 @@ solvers
smoother symGaussSeidel;
tolerance 1e-6;
relTol 0.1;
minIter 1;
}
"(U|k|epsilon)Final"
{
$U;
tolerance 1e-6;
relTol 0;
}
}
@ -78,8 +79,8 @@ solvers
PIMPLE
{
correctPhi yes;
nOuterCorrectors 1;
nCorrectors 3;
nOuterCorrectors 3;
nCorrectors 1;
nNonOrthogonalCorrectors 0;
}

View File

@ -4,7 +4,7 @@ cd ${0%/*} || exit 1 # run from this directory
# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions
# copy bullet surface from resources folder
# copy bullet surface from resources directory
cp $FOAM_TUTORIALS/resources/geometry/bullet.stl.gz constant/triSurface/
# Generate the base block mesh

View File

@ -1,4 +1,4 @@
Folder to house tri-surfaces
Directory to house tri-surfaces
The Allrun script copies the surface from the $FOAM_TUTORIALS/resources/geometry
folder
directory

View File

@ -1,7 +1,7 @@
#!/bin/sh
cd ${0%/*} || exit 1 # run from this directory
# Clean time folders only
# Clean time directories only
rm -rf *[1-9]*
rm -f log.* 2>/dev/null