14_time

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

#!/bin/sh
cd "${0%/*}" || exit 1                              # Run from this directory
#------------------------------------------------------------------------------

appPath=$(cd `dirname $0`; pwd)                     # Get application path
appName="${appPath##*/}"                            # Get application name

blockMesh -case debug_case | tee debug_case/log.mesh
echo "Meshing done."

$appName -case debug_case | tee debug_case/log.run

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

#!/bin/sh
cd "${0%/*}" || exit 1                              # Run from this directory
#------------------------------------------------------------------------------

appPath=$(cd `dirname $0`; pwd)
appName="${casePath##*/}"

cd debug_case

rm -rf log.*
foamCleanTutorials
echo "Cleaning Done."

1
2
3
4
5
6
7

Foam::Info<< "Create time\n" << Foam::endl;
// A simple output statement

Foam::Time runTime(Foam::Time::controlDictName, args);
// Constructs a runTime object of the Foam::Time class
// The construction is based on controlDictName and args
// args needs to be created in advance, so setRootCase.H must come before this

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

...
class Time
:
    public clock,
    public cpuTime,
    public TimePaths,
    public objectRegistry,
    public TimeState
    // The Time class inherits from several base classes
{
public:
	...
private:
	...
protected:
	...
private:
	...
public:
	...
	// Constructor based on parameters
	inline Time
	(
		const word& ctrlDictName, // Reference to a word type
		const argList& args, // Reference to an argList type
		const bool enableFunctionObjects = true,
		const bool enableLibs = true
	);
	// Find this inline function; it is the method prototype for line 2 of createTime.H
	// The third and fourth formal parameters default to true and can be omitted
	// This constructor corresponds to the construction in createTime.H
	
	...
	
	// Searching

	//- Return time instance (location) of \c directory containing
	//- the file \c name (eg, used in reading mesh data).
	//- When \c name is empty, searches for \c directory only.
	//- Does not search beyond \c stopInstance (if set) or \c constant.
	//
	//  If the instance cannot be found:
	//  - FatalError when readOpt is MUST_READ or READ_MODIFIED
	//  - return \c stopInstance (if set and reached)
	//  - return \c constant if constant_fallback is true
	//  - return an empty word if constant_fallback is false
	//  .
	word findInstance
	(
		//! The subdirectory (local) for the search
		const fileName& directory,
		//! The filename for the search. If empty, only search for directory
		const word& name = word::null,
		//! The search type : generally MUST_READ or READ_IF_PRESENT
		IOobjectOption::readOption rOpt = IOobjectOption::MUST_READ,
		//! The search stop instance
		const word& stopInstance = word::null,
		//! Return \c "constant" instead of \c "" if the search failed
		const bool constant_fallback = true
	) const;
	// It can be seen that the Time class provides a search mechanism
	// Starting from the current time, it searches through time directories from the most recent to the earliest,
	// until it finds a time instance containing the directory, or reaches the set stopInstance.
	// If still not found, and constant_fallback is true, it checks the constant directory.
	// If still not found, it reports an error based on the read option, otherwise returns an empty string.
	// This mechanism is generally used to find mesh data.
	// Code details will not be delved into at this stage.
	
	...
	
	// Member Functions
		// Access
		// Member functions of the Time class
		//- Return start time
		virtual dimensionedScalar startTime() const;

		//- Return end time
		virtual dimensionedScalar endTime() const;

		//- Return the stop control information
		virtual stopAtControls stopAt() const;
	...
	
	
...

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

#include "fvCFD.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

int main(int argc, char *argv[])
{
    #include "setRootCase.H"
    // #include "createTime.H"
    // Expand the content of createTime.H
    Foam::Info<< "Create time\n" << Foam::endl;
    Foam::Time runTime(Foam::Time::controlDictName, args);
    // The runTime object is created
    // This object has the member methods and properties of the Time class


    Info<< "Case name   :   " << runTime.caseName() << endl;
    Info<< "Root path   :   " << runTime.rootPath() << endl;
    Info<< "Path        :   " << runTime.path() << endl;
    Info<< "Time path   :   " << runTime.timePath() << endl;
    Info<< "Constant path :   " << runTime.constantPath() << endl;
    Info<< "Constant    :   " << runTime.constant() << endl;
    Info<< "System path :   " << runTime.systemPath() << endl;
    Info<< "Controdict  :   " << runTime.controlDict() << endl;
    Info<< "Format      :   " << runTime.writeFormat() << endl;
    Info<< "Version     :   " << runTime.writeVersion() << endl;
    Info<< "Start time  :   " << runTime.startTime() << endl;
    Info<< "End time    :   " << runTime.endTime() << endl;
    Info<< "Time step   :   " << runTime.deltaT() << endl;

    Info<< "# set end time = 10" << endl;
    runTime.setEndTime(10);

    Info<< "# set deltaT = 1" << endl;
    runTime.setDeltaT(1);

    Info<< "Start time  :   " << runTime.startTime() << endl;
    Info<< "End time    :   " << runTime.endTime() << endl;
    Info<< "Time step   :   " << runTime.deltaT() << endl;


    while (runTime.loop())
    {
        Info<< "Time: " << runTime.timeName() << endl;
        runTime.write();
    }

    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

    Info<< nl;
    // runTime.printExecutionTime(Info);
    // Expand the main content of the member function printExecutionTime()
    Info<< "Execution time: " << runTime.elapsedCpuTime() << " s" << endl;
    Info<< "Clock time: " << runTime.elapsedClockTime() << " s" << endl;

    Info<< "End\n" << endl;

    return 0;
}