TimePaths.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2014 OpenFOAM Foundation
    Copyright (C) 2016-2025 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

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

    OpenFOAM 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 OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::TimePaths

Description
    Address the time paths without using the Time class.

SourceFiles
    TimePaths.C

\*---------------------------------------------------------------------------*/

#ifndef Foam_TimePaths_H
#define Foam_TimePaths_H

#include "fileName.H"
#include "instantList.H"
#include "IOobjectOption.H"

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

namespace Foam
{

// Forward Declarations
class argList;

/*---------------------------------------------------------------------------*\
                           Class TimePaths Declaration
\*---------------------------------------------------------------------------*/

class TimePaths
{
    // Private Data

        //- True if this is a processor case
        bool processorCase_;

        //- True running with distributed directories
        bool distributed_;

        //- The root path
        const fileName rootPath_;

        //- The global case name
        fileName globalCaseName_;

        //- The local (processor) case name
        fileName caseName_;

        //- The name for the "system" directory
        const word system_;

        //- The name for the "constant" directory
        const word constant_;


    // Private Member Functions

        //- If not already designated as a processor-case, determine from
        //- the globalCaseName whether it is a processor directory
        //- and adjust both the globalCaseName and processor-case accordingly
        bool detectProcessorCase();

public:

    // Constructors

        //- Construct from all components
        TimePaths
        (
            const bool processorCase,
            const fileName& rootPath,
            const bool distributed,
            const fileName& globalCaseName,
            const fileName& caseName,
            const word& systemDirName = "system",
            const word& constantDirName = "constant"
        );

        //- Construct using characteristics given by the argList
        explicit TimePaths
        (
            const argList& args,
            const word& systemDirName = "system",
            const word& constantDirName = "constant"
        );

        //- Construct from rootPath and casePath
        inline TimePaths
        (
            const fileName& rootPath,
            const fileName& caseName,
            const word& systemDirName = "system",
            const word& constantDirName = "constant"
        );


    // Member Functions

        //- True if case running with parallel distributed directories
        //- (ie. not NFS mounted)
        inline bool distributed() const noexcept;

        //- True if this is a processor case
        inline bool processorCase() const noexcept;

        //- Set processor case status. Return old status
        inline bool processorCase(bool on) noexcept;

        //- Return root path
        inline const fileName& rootPath() const noexcept;

        //- Return global case name
        inline const fileName& globalCaseName() const noexcept;

        //- Return case name
        inline const fileName& caseName() const noexcept;

        //- The case name for modification (use with caution)
        inline fileName& caseName() noexcept;

        //- Return caseName() or globalCaseName()
        inline const fileName& caseName(IOobjectOption::Layout) const noexcept;

        //- Return path for the case = rootPath/caseName
        inline fileName path() const;

        //- Return global path for the case = rootPath/globalCaseName
        inline fileName globalPath() const;

        //- Return path() or globalPath()
        inline fileName path(IOobjectOption::Layout) const;

        //- Return the input relative to the globalPath by stripping off
        //- a leading value of the globalPath
        //
        //  \param input the directory or filename to make case-relative
        //  \param caseTag replace globalPath with <case> for later
        //      use with expand(), or prefix <case> if the file name was
        //      not an absolute location
        inline fileName relativePath
        (
            const fileName& input,
            const bool caseTag = false
        ) const;


        //- Return constant name
        inline const word& constant() const noexcept;

        //- Return system name
        inline const word& system() const noexcept;

        //- Return the constant name for the case, which is
        //- \c ../constant() for parallel runs.
        inline fileName caseConstant() const;

        //- Return the system name for the case, which is
        //- \c ../system() for parallel runs.
        inline fileName caseSystem() const;

        //- Return constant path
        inline fileName constantPath() const;

        //- Return system path
        inline fileName systemPath() const;


    // Searching (Static Methods)

        //- Search a given directory for valid time directories
        //  \note forwards to the current fileHandler
        static instantList findTimes
        (
            const fileName& directory,
            const word& constantDirName = "constant"
        );

        //- Search instant list for the time index closest to the specified time
        //  \returns -1 if nothing close is found
        static label findClosestTimeIndex
        (
            const UList<instant>& timeDirs,
            const scalar t,
            const word& constantDirName = "constant"
        );

        //- Search instant list for the instant closest to the specified time
        static instant findClosestTime
        (
            const UList<instant>& timeDirs,
            const scalar t,
            const word& constantDirName = "constant"
        );

        //- Search instantList for matching time value,
        //- return the instance name or word::null if nothing is equal.
        static word findInstancePath
        (
            const UList<instant>& timeDirs,
            const instant& t
        );

        //- Search the given directory for matching time value,
        //- return the instance name or word::null if nothing is equal.
        static word findInstancePath
        (
            const fileName& directory,
            const instant& t,
            const word& constantDirName = "constant"
        );


    // Searching

        //- Search the case for valid time directories
        //  \note forwards to the current fileHandler
        instantList times() const;

        //- Search local or global locations for valid time directories
        //  \note forwards to the current fileHandler
        instantList times(IOobjectOption::Layout) const;

        //- Search the case for the time closest to the given time
        //  \note forwards to the current fileHandler
        instant findClosestTime(const scalar t) const;

        //- Search local or global locations for the time closest to
        //- the given time
        //  \note forwards to the current fileHandler
        instant findClosestTime(IOobjectOption::Layout, const scalar t) const;

        //- Search the case for the time directory path
        //- corresponding to the given instance
        //  \note forwards to the current fileHandler
        word findInstancePath(const instant& t) const;

        //- Search local or global locations for the time directory path
        //- corresponding to the given instance
        //  \note forwards to the current fileHandler
        word findInstancePath(IOobjectOption::Layout, const instant& t) const;
};


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

} // End namespace Foam

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

#include "TimePathsI.H"

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

#endif

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