off_free_conditions_object Module

Uses:
off_error_object
finer
penf
vecfor

OFF free conditions object definition and implementation.

Used By

Variables

INI_SECTION_NAME

Derived Types

free_conditions_object

Functions

description

Subroutines

destroy free_assign_free initialize load_from_file save_into_file

Variables

Type	Visibility	Attributes		Name		Initial
character(len=15),	private,	parameter	::	INI_SECTION_NAME	=	'free_conditions'	INI (config) file section name containing the free stream conditions.

Derived Types

type, public :: free_conditions_object

Free conditions object class.

Components

Type	Visibility	Attributes		Name		Initial
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.
procedure, public, pass(self) :: destroy	Destroy free conditions.
procedure, public, pass(lhs) :: free_assign_free	Operator `=`.
procedure, public, pass(self) :: initialize	Initialize free conditions.
procedure, public, pass(self) :: load_from_file	Load from file.
procedure, public, pass(self) :: save_into_file	Save into file.

Functions

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

Return a pretty-formatted description of the free conditions.

Arguments

Type	Intent	Optional	Attributes		Name
class(free_conditions_object),	intent(in)			::	self	Free conditions.
character(len=*),	intent(in),	optional		::	prefix	Prefixing string.

Return Value character(len=:), allocatable

Description.

Subroutines

private elemental subroutine destroy(self)

Destroy free conditions.

Arguments

Type	Intent	Optional	Attributes		Name
class(free_conditions_object),	intent(inout)			::	self	Free conditions.

private pure subroutine free_assign_free(lhs, rhs)

Operator =.

Arguments

Type	Intent	Optional	Attributes		Name
class(free_conditions_object),	intent(inout)			::	lhs	Left hand side.
type(free_conditions_object),	intent(in)			::	rhs	Right hand side.

private elemental subroutine initialize(self)

Initialize free conditions.

Arguments

Type	Intent	Optional	Attributes		Name
class(free_conditions_object),	intent(inout)			::	self	Free conditions.

private subroutine load_from_file(self, fini, go_on_fail)

Load from file.

Arguments

Type	Intent	Optional	Attributes		Name
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.

private subroutine save_into_file(self, fini)

Save into file.

Arguments

Type	Intent	Optional	Attributes		Name
class(free_conditions_object),	intent(inout)			::	self	Free conditions.
type(file_ini),	intent(inout)			::	fini	Simulation parameters ini file handler.

All Modules

off_block_object off_block_signature_object off_cell_object off_error_object off_face_object off_file_grid_object off_file_object off_files_collection_object off_free_conditions_object off_grid_dimensions_object off_node_object off_non_dimensional_numbers_object off_objects off_os_object off_simulation_object off_solver_object off_time_object