files_collection_object Derived Type

type, public :: files_collection_object

type~~files_collection_object~~InheritsGraph type~files_collection_object files_collection_object type~file_object file_object type~file_object->type~files_collection_object boundary_conditions, grid, initial_conditions, logging, solution type~error_object error_object type~error_object->type~file_object error
Help


Files collection object class.



Components

TypeVisibility AttributesNameInitial
type(file_object), public :: boundary_conditions

Boundary conditions file.

type(file_object), public :: grid

Grid file.

type(file_object), public :: initial_conditions

Initial conditions file.

type(file_object), public :: logging

Logging file.

type(file_object), public :: solution

Solution file.


Type-Bound Procedures

procedure, public, pass(self) :: description

Return a pretty-formatted description of the files collection.

  • private pure function description(self, prefix) result(desc)

    Return a pretty-formatted description of the files collection.

    Arguments

    Type IntentOptional AttributesName
    class(files_collection_object), intent(in) :: self

    Files collection.

    character(len=*), intent(in), optional :: prefix

    Prefixing string.

    Return Value character(len=:), allocatable

    Description.

procedure, public, pass(self) :: destroy

Destroy files collection.

  • private elemental subroutine destroy(self)

    Destroy files collection.

    Arguments

    Type IntentOptional AttributesName
    class(files_collection_object), intent(inout) :: self

    Files collection.

procedure, public, pass(self) :: initialize

Initialize files collection.

  • private elemental subroutine initialize(self)

    Initialize Files collection.

    Arguments

    Type IntentOptional AttributesName
    class(files_collection_object), intent(inout) :: self

    Files collection.

procedure, public, pass(self) :: load_from_file

Load from file.

  • private subroutine load_from_file(self, fini, go_on_fail)

    Load from file.

    Arguments

    Type IntentOptional AttributesName
    class(files_collection_object), intent(inout) :: self

    Files collection.

    type(file_ini), intent(in) :: fini

    Simulation parameters ini file handler.

    logical, intent(in), optional :: go_on_fail

    Go on if load fails..

procedure, public, pass(self) :: save_into_file

Save into file.

  • private subroutine save_into_file(self, fini)

    Save from file.

    Arguments

    Type IntentOptional AttributesName
    class(files_collection_object), intent(inout) :: self

    Files collection.

    type(file_ini), intent(inout) :: fini

    Simulation parameters ini file handler.

Source Code

type :: files_collection_object
  !< Files collection object class.
  type(file_object) :: boundary_conditions !< Boundary conditions file.
  type(file_object) :: grid                !< Grid file.
  type(file_object) :: initial_conditions  !< Initial conditions file.
  type(file_object) :: logging             !< Logging file.
  type(file_object) :: solution            !< Solution file.
  contains
    ! public methods
    procedure, pass(self) :: description    !< Return a pretty-formatted description of the files collection.
    procedure, pass(self) :: destroy        !< Destroy files collection.
    procedure, pass(self) :: initialize     !< Initialize files collection.
    procedure, pass(self) :: load_from_file !< Load from file.
    procedure, pass(self) :: save_into_file !< Save into file.
endtype files_collection_object