Mercurial > repos > public > sbplib

comparison +scheme/bcSetup.m @ 899:ba10f24bf476 bcSetupExperiment

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix the documentation of functions
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 24 Nov 2018 15:48:00 +0100
parents 93489ddb73e8
children b45a6dcb61ac
comparison
equal deleted inserted replaced
895:ba037fd21e9f 899:ba10f24bf476
1 % function [closure, S] = bcSetup(diffOp, bc)
2 % Takes a diffOp and a cell array of boundary condition definitions. 1 % Takes a diffOp and a cell array of boundary condition definitions.
3 % Each bc is a struct with the fields 2 % Each bc is a struct with the fields
4 % * type -- Type of boundary condition 3 % * type -- Type of boundary condition
5 % * boundary -- Boundary identifier 4 % * boundary -- Boundary identifier
6 % * data -- A function_handle for a function which provides boundary data.(see below) 5 % * data -- A function_handle for a function which provides boundary data.(see below)
7 % Also takes S_sign which modifies the sign of S, [-1,1] 6 % Also takes S_sign which modifies the sign of the penalty function, [-1,1]
8 % Returns a closure matrix and a forcing function S. 7 % Returns a closure matrix and a forcing function S.
9 % 8 %
10 % The boundary data function can either be a function of time or a function of time and space coordinates. 9 % The boundary data function can either be a function of time or a function of time and space coordinates.
11 % In the case where it only depends on time it should return the data as grid function for the boundary. 10 % In the case where it only depends on time it should return the data as grid function for the boundary.
12 % In the case where it also takes space coordinates the number of space coordinates should match the number of dimensions of the problem domain. 11 % In the case where it also takes space coordinates the number of space coordinates should match the number of dimensions of the problem domain.