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 => brinkman_source_term_init_from_json
	The common constructor using a JSON object. More...
procedure, pass(this), public	free => brinkman_source_term_free
	Destructor. More...
procedure, pass(this), public	compute_ => brinkman_source_term_compute
	Computes the source term and adds the result to fields. More...
procedure, pass(this)	init_boundary_mesh
procedure, pass(this)	init_point_zone
procedure, pass(this)	init_base => source_term_init_base
	Constructor for the source_term_t (base) type. More...
procedure, pass(this)	free_base => source_term_free_base
	Destructor for the source_term_t (base) type. More...
procedure, pass(this)	compute => source_term_compute_wrapper
	Executes compute_ based on time conditions. More...

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

Detailed Description

Definition at line 55 of file brinkman_source_term.f90.

Member Function/Subroutine Documentation

compute()

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

inherited

Definition at line 58 of file source_term.f90.

compute_()

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

Definition at line 69 of file brinkman_source_term.f90.

free()

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

Definition at line 67 of file brinkman_source_term.f90.

free_base()

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

inherited

Definition at line 56 of file source_term.f90.

init()

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

Definition at line 64 of file brinkman_source_term.f90.

init_base()

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

inherited

Definition at line 54 of file source_term.f90.

init_boundary_mesh()

procedure, pass(this) brinkman_source_term::brinkman_source_term_t::init_boundary_mesh

Definition at line 73 of file brinkman_source_term.f90.

init_point_zone()

procedure, pass(this) brinkman_source_term::brinkman_source_term_t::init_point_zone

Definition at line 74 of file brinkman_source_term.f90.

Member Data Documentation

brinkman

type(field_t) brinkman_source_term::brinkman_source_term_t::brinkman

Definition at line 61 of file brinkman_source_term.f90.

coef

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

inherited

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)

inherited

Definition at line 51 of file source_term.f90.

fields

type(field_list_t) source_term::source_term_t::fields

inherited

Definition at line 45 of file source_term.f90.

indicator

type(field_t) brinkman_source_term::brinkman_source_term_t::indicator

Definition at line 59 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 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/brinkman_source_term.f90