source_term::source_term_t Type Reference

Base abstract type for source terms. More...

Inheritance diagram for source_term::source_term_t:

Collaboration diagram for source_term::source_term_t:

Public Member Functions
procedure, pass(this)	init_base (this, fields, coef, start_time, end_time)
	Constructor for the source_term_t (base) type.
procedure, pass(this)	free_base (this)
	Destructor for the source_term_t (base) type.
procedure, pass(this)	compute (this, t, tstep)
	Executes compute_ based on time conditions.
procedure(source_term_init), deferred, pass	init (this, json, fields, coef)
	The common constructor using a JSON object.
procedure(source_term_free), deferred, pass	free (this)
	Destructor.
procedure(source_term_compute), deferred, pass	compute_ (this, t, tstep)
	Computes the source term and adds the result to fields.

Public Attributes
type(field_list_t)	fields
	The fields to be updated with the source term values.
type(coef_t), pointer	coef => null()
	Coefficients for the SEM.
real(kind=rp)	start_time = 0.0_rp
	Start time for adding the source term.
real(kind=rp)	end_time = huge(0.0_rp)
	End time for adding the source term.

Detailed Description

Definition at line 43 of file source_term.f90.

Member Function/Subroutine Documentation

compute()

procedure, pass(this) source_term::source_term_t::compute	(	class(source_term_t), intent(inout)	this,
		real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep
	)

Parameters

t	Time value.
tstep	Current time step.

Definition at line 58 of file source_term.f90.

compute_()

procedure(source_term_compute), deferred, pass source_term::source_term_t::compute_ ( class(source_term_t), intent(inout)  this, real(kind=rp), intent(in)  t, integer, intent(in)  tstep  )

pure virtual

Definition at line 64 of file source_term.f90.

free()

procedure(source_term_free), deferred, pass source_term::source_term_t::free ( class(source_term_t), intent(inout)  this )

pure virtual

Definition at line 62 of file source_term.f90.

free_base()

procedure, pass(this) source_term::source_term_t::free_base

(

class(source_term_t), intent(inout)

this

)

Definition at line 56 of file source_term.f90.

init()

procedure(source_term_init), deferred, pass source_term::source_term_t::init ( class(source_term_t), intent(inout)  this, type(json_file), intent(inout)  json, type(field_list_t), intent(in), target  fields, type(coef_t), intent(in), target  coef  )

pure virtual

Definition at line 60 of file source_term.f90.

init_base()

procedure, pass(this) source_term::source_term_t::init_base	(	class(source_term_t), intent(inout)	this,
		type(field_list_t)	fields,
		type(coef_t), intent(in), target	coef,
		real(kind=rp), intent(in)	start_time,
		real(kind=rp), intent(in)	end_time
	)

Parameters

json	JSON object initializing the source term.
fields	The list of fields updated by the source term.
coef	The SEM coefficients. Constructor for the source_term_t (base) type.
fields	A list of pointers to fields to be updated by the source term.
coef	SEM coefs.
start_time	When to start adding the source term.
end_time	When to stop adding the source term.

Definition at line 54 of file source_term.f90.

Member Data Documentation

coef

type(coef_t), pointer source_term::source_term_t::coef => null()

Definition at line 47 of file source_term.f90.

end_time

real(kind=rp) source_term::source_term_t::end_time = huge(0.0_rp)

Definition at line 51 of file source_term.f90.

fields

type(field_list_t) source_term::source_term_t::fields

Definition at line 45 of file source_term.f90.

start_time

real(kind=rp) source_term::source_term_t::start_time = 0.0_rp

Definition at line 49 of file source_term.f90.

---

The documentation for this type was generated from the following file:

• /home/runner/work/neko/neko/src/source_terms/source_term.f90