Neko  0.9.0
A portable framework for high-order spectral element flow simulations
field_dirichlet::field_dirichlet_t Type Reference

User defined dirichlet condition, for which the user can work with an entire field. The type stores a separate dummy field field_bc, which is passed to the user routine and can be populated with arbitrary values. The boundary condition then copy-pastes these values to the actual solution field using the mask of the boundary condition. So, in the end, only the relevant boundary values are updated. More...

Inheritance diagram for field_dirichlet::field_dirichlet_t:
Collaboration diagram for field_dirichlet::field_dirichlet_t:

Public Member Functions

procedure, pass(this) init_field => field_dirichlet_init
 Constructor. More...
 
procedure, pass(this) apply_scalar => field_dirichlet_apply_scalar
 Apply scalar by performing a masked copy. More...
 
procedure, pass(this) apply_vector => field_dirichlet_apply_vector
 (No-op) Apply vector. More...
 
procedure, pass(this) apply_vector_dev => field_dirichlet_apply_vector_dev
 (No-op) Apply vector (device). More...
 
procedure, pass(this) apply_scalar_dev => field_dirichlet_apply_scalar_dev
 Apply scalar (device). More...
 
procedure, pass(this) free => field_dirichlet_free
 Destructor. More...
 
procedure, pass(this) init_base => bc_init_base
 Constructor. More...
 
procedure, pass(this) free_base => bc_free_base
 Destructor. More...
 
procedure, pass(this) mark_facet => bc_mark_facet
 Mark a facet on an element as part of the boundary condition. More...
 
procedure, pass(this) mark_facets => bc_mark_facets
 Mark all facets from a (facet, element) tuple list. More...
 
procedure, pass(this) mark_zones_from_list => bc_mark_zones_from_list
 Mark all facets from a list of zones, also marks type of bc in the mesh. More...
 
procedure, pass(this) mark_zone => bc_mark_zone
 Mark all facets from a zone. More...
 
procedure, pass(this) finalize => bc_finalize
 Finalize the construction of the bc by populting the msk and facet arrays. More...
 

Public Attributes

type(field_tfield_bc
 A dummy field which can be manipulated by the user to set the boundary values. More...
 
type(field_list_tfield_list
 A field list, which just stores field_bc, for convenience. More...
 
procedure(field_dirichlet_update), pointer, nopass update => null()
 Function pointer to the user routine performing the update of the values of the boundary fields. More...
 
integer, dimension(:), allocatable msk
 The linear index of each node in each boundary facet. More...
 
integer, dimension(:), allocatable facet
 A list of facet ids (1 to 6), one for each element in msk. More...
 
type(dofmap_t), pointer dof
 Map of degrees of freedom. More...
 
type(coef_t), pointer coef
 SEM coefficients. More...
 
type(mesh_t), pointer msh
 The mesh. More...
 
type(space_t), pointer xh
 The function space. More...
 
type(stack_i4t2_t) marked_facet
 Index tuples (facet, element) marked as part of the boundary condition. More...
 
type(c_ptr) msk_d = C_NULL_PTR
 Device pointer for msk. More...
 
type(c_ptr) facet_d = C_NULL_PTR
 Device pointer for facet. More...
 

Detailed Description

Note
Would be neat to add another class that contains all three dirichlet bcs for the velocity, this bc would then implement apply_vector.

Definition at line 61 of file field_dirichlet.f90.

Member Function/Subroutine Documentation

◆ apply_scalar()

procedure, pass(this) field_dirichlet::field_dirichlet_t::apply_scalar

Definition at line 74 of file field_dirichlet.f90.

◆ apply_scalar_dev()

procedure, pass(this) field_dirichlet::field_dirichlet_t::apply_scalar_dev

Definition at line 80 of file field_dirichlet.f90.

◆ apply_vector()

procedure, pass(this) field_dirichlet::field_dirichlet_t::apply_vector

Definition at line 76 of file field_dirichlet.f90.

◆ apply_vector_dev()

procedure, pass(this) field_dirichlet::field_dirichlet_t::apply_vector_dev

Definition at line 78 of file field_dirichlet.f90.

◆ finalize()

procedure, pass(this) bc::bc_t::finalize
inherited

Definition at line 85 of file bc.f90.

◆ free()

procedure, pass(this) field_dirichlet::field_dirichlet_t::free

Definition at line 82 of file field_dirichlet.f90.

◆ free_base()

procedure, pass(this) bc::bc_t::free_base
inherited

Definition at line 74 of file bc.f90.

◆ init_base()

procedure, pass(this) bc::bc_t::init_base
inherited

Definition at line 72 of file bc.f90.

◆ init_field()

procedure, pass(this) field_dirichlet::field_dirichlet_t::init_field

Definition at line 72 of file field_dirichlet.f90.

◆ mark_facet()

procedure, pass(this) bc::bc_t::mark_facet
inherited

Definition at line 76 of file bc.f90.

◆ mark_facets()

procedure, pass(this) bc::bc_t::mark_facets
inherited

Definition at line 78 of file bc.f90.

◆ mark_zone()

procedure, pass(this) bc::bc_t::mark_zone
inherited

Definition at line 82 of file bc.f90.

◆ mark_zones_from_list()

procedure, pass(this) bc::bc_t::mark_zones_from_list
inherited

Definition at line 80 of file bc.f90.

Member Data Documentation

◆ coef

type(coef_t), pointer bc::bc_t::coef
inherited

Definition at line 59 of file bc.f90.

◆ dof

type(dofmap_t), pointer bc::bc_t::dof
inherited

Definition at line 57 of file bc.f90.

◆ facet

integer, dimension(:), allocatable bc::bc_t::facet
inherited

Definition at line 55 of file bc.f90.

◆ facet_d

type(c_ptr) bc::bc_t::facet_d = C_NULL_PTR
inherited

Definition at line 69 of file bc.f90.

◆ field_bc

type(field_t) field_dirichlet::field_dirichlet_t::field_bc

Definition at line 64 of file field_dirichlet.f90.

◆ field_list

type(field_list_t) field_dirichlet::field_dirichlet_t::field_list

Definition at line 66 of file field_dirichlet.f90.

◆ marked_facet

type(stack_i4t2_t) bc::bc_t::marked_facet
inherited

Definition at line 65 of file bc.f90.

◆ msh

type(mesh_t), pointer bc::bc_t::msh
inherited

Definition at line 61 of file bc.f90.

◆ msk

integer, dimension(:), allocatable bc::bc_t::msk
inherited

Definition at line 53 of file bc.f90.

◆ msk_d

type(c_ptr) bc::bc_t::msk_d = C_NULL_PTR
inherited

Definition at line 67 of file bc.f90.

◆ update

procedure(field_dirichlet_update), pointer, nopass field_dirichlet::field_dirichlet_t::update => null()

Definition at line 69 of file field_dirichlet.f90.

◆ xh

type(space_t), pointer bc::bc_t::xh
inherited

Definition at line 63 of file bc.f90.


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