free_conditions_object Derived Type

  1. off_free_conditions_object.f90
  2. off_free_conditions_object
  3. free_conditions_object

type, public :: free_conditions_object

type~~free_conditions_object~~InheritsGraph type~free_conditions_object free_conditions_object type~error_object error_object type~error_object->type~free_conditions_object error vector vector vector->type~free_conditions_object velocity
Help


Free conditions object class.

Define the conditions of the free stream.

Inherited By

type~~free_conditions_object~~InheritedByGraph type~free_conditions_object free_conditions_object type~simulation_object simulation_object type~free_conditions_object->type~simulation_object free_conditions
Help

Variables

Type-Bound Procedures

Source Code

free_conditions_object

Components

TypeVisibility AttributesNameInitial
type(error_object), public :: error

Errors handler.
type(vector), public :: velocity

Velocity.

Type-Bound Procedures

generic, public :: assignment(=) => free_assign_free

Overload =.

procedure, public, pass(self) :: description

Return a pretty-formatted description of the free conditions.

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

    Return a pretty-formatted description of the free conditions.

    Arguments

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

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

    Prefixing string.

    Return Value character(len=:), allocatable

    Description.

procedure, public, pass(self) :: destroy

Destroy free conditions.

  • private elemental subroutine destroy(self)

    Destroy free conditions.

    Arguments

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

    Free conditions.

procedure, public, pass(lhs) :: free_assign_free

Operator =.

procedure, public, pass(self) :: initialize

Initialize free conditions.

  • private elemental subroutine initialize(self)

    Initialize free conditions.

    Arguments

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

    Free conditions.

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(free_conditions_object), intent(inout) :: self

    Free conditions.
    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 into file.

    Arguments

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

    Free conditions.
    type(file_ini), intent(inout) :: fini

    Simulation parameters ini file handler.

Source Code

type :: free_conditions_object
   !< Free conditions object class.
   !<
   !< Define the conditions of the **free stream**.
   type(error_object) :: error    !< Errors handler.
   type(vector)       :: velocity !< Velocity.
   contains
      ! public methods
      procedure, pass(self) :: description    !< Return a pretty-formatted description of the free conditions.
      procedure, pass(self) :: destroy        !< Destroy free conditions.
      procedure, pass(self) :: initialize     !< Initialize free conditions.
      procedure, pass(self) :: load_from_file !< Load from file.
      procedure, pass(self) :: save_into_file !< Save into file.
      ! operators
      generic :: assignment(=) => free_assign_free !< Overload `=`.
      ! private methods
      procedure, pass(lhs) :: free_assign_free !< Operator `=`.
endtype free_conditions_object

All Derived Types