brinkman_source_term::brinkman_source_term_t Type Reference

A Brinkman source term. The region and strength are controlled by assigning regions types and brinkman limits to the source term. More...

Inheritance diagram for brinkman_source_term::brinkman_source_term_t:

Collaboration diagram for brinkman_source_term::brinkman_source_term_t:

Public Member Functions
procedure, pass(this), public	init (this, json, fields, coef, variable_name)
	The common constructor using a JSON object.
procedure, pass(this), public	free (this)
	Destructor.
procedure, pass(this), public	compute_ (this, time)
	Computes the source term and adds the result to fields.
procedure, pass(this)	init_boundary_mesh (this, json)
	Initializes the source term from a boundary mesh.
procedure, pass(this)	init_point_zone (this, json)
	Initializes the source term from a point zone.
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, time)
	Executes compute_ based on time conditions.
procedure(source_term_init), deferred, pass	init (this, json, fields, coef, variable_name)
	The common constructor using a JSON object.
procedure(source_term_free), deferred, pass	free (this)
	Destructor.
procedure(source_term_compute), deferred, pass	compute_ (this, time)
	Computes the source term and adds the result to fields.

Public Attributes
type(field_t)	indicator
	The value of the source term.
type(field_t)	brinkman
	Brinkman permeability field.
class(filter_t), allocatable	filter
	Filter.
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.

Private Attributes
type(field_t)	indicator_unfiltered
	The unfiltered indicator field.

Detailed Description

Definition at line 70 of file brinkman_source_term.f90.

Member Function/Subroutine Documentation

compute()

procedure, pass(this) source_term::source_term_t::compute ( class(source_term_t), intent(inout)  this, type(time_state_t), intent(in)  time  )

inherited

Parameters

time	Time state.

Definition at line 59 of file source_term.f90.

compute_() [1/2]

procedure, pass(this), public brinkman_source_term::brinkman_source_term_t::compute_	(	class(brinkman_source_term_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

Parameters

time	The time state.

Definition at line 88 of file brinkman_source_term.f90.

compute_() [2/2]

procedure(source_term_compute), deferred, pass source_term::source_term_t::compute_ ( class(source_term_t), intent(inout)  this, type(time_state_t), intent(in)  time  )

pure virtualinherited

Definition at line 65 of file source_term.f90.

free() [1/2]

procedure, pass(this), public brinkman_source_term::brinkman_source_term_t::free

(

class(brinkman_source_term_t), intent(inout)

this

)

Definition at line 86 of file brinkman_source_term.f90.

free() [2/2]

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

pure virtualinherited

Definition at line 63 of file source_term.f90.

free_base()

procedure, pass(this) source_term::source_term_t::free_base ( class(source_term_t), intent(inout)  this )

inherited

Definition at line 57 of file source_term.f90.

init() [1/2]

procedure, pass(this), public brinkman_source_term::brinkman_source_term_t::init	(	class(brinkman_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,
		character(len=*), intent(in)	variable_name
	)

Parameters

json	The JSON object for the source.
fields	A list of fields for adding the source values.
coef	The SEM coeffs.
variable_name	The name of the variable where the source term acts.

Definition at line 83 of file brinkman_source_term.f90.

init() [2/2]

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, character(len=*), intent(in)  variable_name  )

pure virtualinherited

Definition at line 61 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  )

inherited

Parameters

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 55 of file source_term.f90.

init_boundary_mesh()

procedure, pass(this) brinkman_source_term::brinkman_source_term_t::init_boundary_mesh	(	class(brinkman_source_term_t), intent(inout)	this,
		type(json_file), intent(inout)	json
	)

Definition at line 92 of file brinkman_source_term.f90.

init_point_zone()

procedure, pass(this) brinkman_source_term::brinkman_source_term_t::init_point_zone	(	class(brinkman_source_term_t), intent(inout)	this,
		type(json_file), intent(inout)	json
	)

Definition at line 93 of file brinkman_source_term.f90.

Member Data Documentation

brinkman

type(field_t) brinkman_source_term::brinkman_source_term_t::brinkman

Definition at line 78 of file brinkman_source_term.f90.

coef

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

inherited

Definition at line 48 of file source_term.f90.

end_time

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

inherited

Definition at line 52 of file source_term.f90.

fields

type(field_list_t) source_term::source_term_t::fields

inherited

Definition at line 46 of file source_term.f90.

filter

class(filter_t), allocatable brinkman_source_term::brinkman_source_term_t::filter

Definition at line 80 of file brinkman_source_term.f90.

indicator

type(field_t) brinkman_source_term::brinkman_source_term_t::indicator

Definition at line 76 of file brinkman_source_term.f90.

indicator_unfiltered

type(field_t) brinkman_source_term::brinkman_source_term_t::indicator_unfiltered

private

Definition at line 74 of file brinkman_source_term.f90.

start_time

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

inherited

Definition at line 50 of file source_term.f90.

---

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

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