/[escript]/trunk/escript/src/escriptcpp.cpp
ViewVC logotype

Diff of /trunk/escript/src/escriptcpp.cpp

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3259 by jfenwick, Mon Oct 11 01:48:14 2010 UTC revision 3360 by jfenwick, Thu Nov 18 00:20:21 2010 UTC
# Line 115  BOOST_PYTHON_MODULE(escriptcpp) Line 115  BOOST_PYTHON_MODULE(escriptcpp)
115  "The keys given in the dictionary will be used to name columns.\n"  "The keys given in the dictionary will be used to name columns.\n"
116  "Then the data will be output, one line per sample (for all data).\n"  "Then the data will be output, one line per sample (for all data).\n"
117  "That is, items in each column will be printed in the same order.\n"  "That is, items in each column will be printed in the same order.\n"
118  "So you can be sure that values in the same row correspond to the same input value.\n"  "So you can be sure that values in the same row correspond to the same input value.\n\n"
119  "\n:param filename:\n:type filename: ``string``\n"  "\n:param filename:\n:type filename: ``string``\n"
120  ":param arg: dictionary of named `Data` objects. If one is called ``mask`` it must be scalar data."  ":param arg: dictionary of named `Data` objects. If one is called ``mask`` it must be scalar data.\n"
121  "\n:type arg: ``dict``\n"  ":type arg: ``dict``\n"
122  ":param sep:separator for columns (defaults to \", \"\n:type sep:``string``\n"  ":param sep: separator for columns (defaults to ',')\n"
123  ":param csep:separator for fields within data object (defaults to \"_\"\n:type csep:``string``\n"  ":type sep: ``string``\n"
124    ":param csep: separator for fields within data object (defaults to \"_\")\n:type csep: ``string``\n"
125  ":param append: If True, write to the end of ``filename``\n:type append: ``string``\n");  ":param append: If True, write to the end of ``filename``\n:type append: ``string``\n");
126    
127    
# Line 264  args("arg"), "assigns new location to th Line 265  args("arg"), "assigns new location to th
265    fs_definer.def("getNormal",&escript::FunctionSpace::getNormal,":return: the surface normal field.\n\n:rtype: `Data`");    fs_definer.def("getNormal",&escript::FunctionSpace::getNormal,":return: the surface normal field.\n\n:rtype: `Data`");
266    fs_definer.def("getSize",&escript::FunctionSpace::getSize,":return: sample size\n:rtype: `Data`");    fs_definer.def("getSize",&escript::FunctionSpace::getSize,":return: sample size\n:rtype: `Data`");
267    fs_definer.def("setTags",&escript::FunctionSpace::setTags,args("newtag","mask"),    fs_definer.def("setTags",&escript::FunctionSpace::setTags,args("newtag","mask"),
268  "Set tags according to a mask\n\n:param newtag: tag number to set\n:type newtag: non-zero ``int``\n:param mask: Samples which correspond to positive values in the mask will be set to ``newtag``.\n:type mask: scalar `Data`");  "Set tags according to a mask\n\n:param newtag: tag number to set\n:type newtag: string, non-zero ``int``\n:param mask: Samples which correspond to positive values in the mask will be set to ``newtag``.\n:type mask: scalar `Data`");
269    fs_definer.def("setTags",&escript::FunctionSpace::setTagsByString,args("newtag","mask"),    fs_definer.def("setTags",&escript::FunctionSpace::setTagsByString,args("newtag","mask"));
 "Set tags according to a mask\n\n:param newtag: tag name to set\n:type newtag: string\n:param mask: Samples which correspond to positive values in the mask will be set to ``newtag``.\n:type mask: scalar `Data`");  
270    fs_definer.def("getTagFromDataPointNo",    fs_definer.def("getTagFromDataPointNo",
271                   &escript::FunctionSpace::getTagFromDataPointNo,":return: the tag associated with the given sample number.\n:rtype: int");                   &escript::FunctionSpace::getTagFromDataPointNo,":return: the tag associated with the given sample number.\n:rtype: int");
272    fs_definer.def("getReferenceIDFromDataPointNo", &escript::FunctionSpace::getReferenceIDFromDataPointNo,args("dataPointNo"),":return: the reference number associated with ``dataPointNo``\n:rtype: int ");    fs_definer.def("getReferenceIDFromDataPointNo", &escript::FunctionSpace::getReferenceIDFromDataPointNo,args("dataPointNo"),":return: the reference number associated with ``dataPointNo``\n:rtype: int ");
# Line 350  args("arg"), "assigns new location to th Line 350  args("arg"), "assigns new location to th
350  "\n:rtype: `Data`"  "\n:rtype: `Data`"
351  )  )
352      .def("interpolateTable", &escript::Data::interpolateFromTable1DP,      .def("interpolateTable", &escript::Data::interpolateFromTable1DP,
353  (arg("table"),arg("Amin"),arg("Astep"), arg("undef")=1.e50, arg("check_boundaries")=false),  (arg("table"),arg("Amin"),arg("Astep"), arg("undef")=1.e50, arg("check_boundaries")=false)/*,
354  "Creates a new Data object by interpolating using the source data (which are\n"  "Creates a new Data object by interpolating using the source data (which are\n"
355  "looked up in ``table``)\n\n"  "looked up in ``table``)\n\n"
356  ":param table: one dimensional collection of values\n"  ":param table: one dimensional collection of values\n"
# Line 360  args("arg"), "assigns new location to th Line 360  args("arg"), "assigns new location to th
360  ":param check_boundaries: if true, then values outside the boundaries will be rejected. If false, then boundary values will be used.\n"  ":param check_boundaries: if true, then values outside the boundaries will be rejected. If false, then boundary values will be used.\n"
361  ":raise RuntimeError(DataException): if the cordinates do not map into the table or if the interpolated value is above ``undef``"  ":raise RuntimeError(DataException): if the cordinates do not map into the table or if the interpolated value is above ``undef``"
362  "\n:rtype: `Data`"  "\n:rtype: `Data`"
363    */
364  )  )
365    
366    

Legend:
Removed from v.3259  
changed lines
  Added in v.3360

  ViewVC Help
Powered by ViewVC 1.1.26